Upload 10 files

LICENSE

@@ -0,0 +1,324 @@
+                 Yi Series Models Community License Agreement
+                                 Version: 2.1
+                       Date of Release: November 23, 2023
+ 
+1. Definition
+
+“Agreement” refers to the terms and conditions defined in this Yi Series Models 
+Community License Agreement for the use, reproduction and distribution of Yi 
+Series Models.
+ 
+“Model” refers to associated components (including checkpoints) developed based
+on machine learning, including learned weights and parameters (including the
+status of optimizer).
+ 
+“Yi Series Models” refers to opensource models with different specifications and
+capabilities named “Yi” provided by the Licensor, including Yi-6B, Yi-34B etc.
+ 
+“Derivatives” refers to all modifications to Yi Series Models, work based on Yi
+Series Models, or any other models created or initialized by transferring the
+weights, parameters, activations, or output patterns of Yi Series Models to
+other models to achieve similar performance, including but not limited to
+methods that require using intermediate data representations or generating
+synthetic data based on Yi Series Models to train other models.
+ 
+“Licensor” refers to Beijing Lingyiwanwu Information Technology Co., Ltd.
+ 
+“you” refers to an individual or legal entity that exercises the license granted
+by this Agreement and/or uses the Yi Series Models for any purpose and in any
+field of use.
+ 
+“Third Party” refers to any individuals, legal entities or non-legal 
+organizations other than you.
+ 
+“Distribute” refers to transmitting, copying, publishing, or otherwise sharing 
+the Yi Series Models with third parties, including providing the Yi Series
+Models through electronic or other remote means (such as any SaaS software or
+PaaS software accessed via API or web access).
+ 
+“Commercial Purposes” refers to the use of the Yi Series Models, directly or
+indirectly, for the operation, promotion, revenue generation, or any other
+profit-making purposes for entities or individuals.
+ 
+“Laws and Regulations” refers to the laws and administrative regulations of the
+mainland of the People's Republic of China (for the purposes of this Agreement
+only, excluding Hong Kong, Macau, and Taiwan).
+ 
+“Personal Information” refers to various information related to identified or
+identifiable natural persons recorded electronically or by other means,
+excluding information that has been anonymized.
+ 
+“Logo” refers to any trademark, service mark, trade name, domain name, website
+name, or other distinctive branding marks.
+ 
+2. License and License Restrictions
+The Licensor hereby grants you a non-exclusive, global, non-transferable,
+non-sub-licensable, revocable, and royalty-free copyright license. You must
+adhere to the following license restrictions:
+ 
+1) Your use of the Yi Series Models must comply with the Laws and Regulations as
+well as applicable legal requirements of other countries/regions, and respect
+social ethics and moral standards, including but not limited to, not using the
+Yi Series Models for purposes prohibited by Laws and Regulations as well as
+applicable legal requirements of other countries/regions, such as harming
+national security, promoting terrorism, extremism, inciting ethnic or racial
+hatred, discrimination, violence, or pornography, and spreading false harmful
+information.
+ 
+2) You shall not, for military or unlawful purposes or in ways not allowed by
+Laws and Regulations as well as applicable legal requirements of other
+countries/regions, a) use, copy or Distribute the Yi Series Models, or b) create
+complete or partial Derivatives of the Yi Series Models.
+ 
+3) Your use of the Yi Series Models (including using the output of the Yi Series
+Models) and the creation of Derivatives must not infringe upon the legitimate
+rights of any Third Party, including but not limited to the rights of personal
+rights such as the right to likeness, reputation, and privacy, as well as
+intellectual property rights such as copyrights, patents, trade secrets, and
+other property rights.
+ 
+4) You must clearly attribute the source of the Yi Series Models to the Licensor
+and provide a copy of this Agreement to any Third-Party users of the Yi Series
+Models and Derivatives.
+ 
+5) If you modify the Yi Series Models to create Derivatives, you must clearly
+indicate the substantial modifications made, and these modifications shall not
+violate the license restrictions of this Agreement. You shall not enable,
+assist, or in any way facilitate Third Parties to violate the license
+restrictions of this Agreement.
+ 
+If you plan to use the Yi Series Models and Derivatives for Commercial Purposes, 
+please refer to the Registration Form of Yi Series Models for Commercial Purposes 
+(“Registration Form”), as provided in Attachment 1 of the Yi Series Models 
+Commercial License Agreement (available at https://www.lingyiwanwu.com/yi-license) 
+and send completed Registration Form to the email: yi@01.ai to complete the 
+registration and obtain the license for Commercial Purposes. If you obtained the 
+license for Commercial Purposes and use the Yi Series Models and Derivatives for 
+Commercial Purposes, you must comply with the afore-mentioned license restrictions 
+and restrictions specified under the Yi Series Models Commercial License Agreement.
+ 
+ 
+3. Intellectual Property
+The ownership of the Yi Series Models and their related intellectual property
+rights is solely held by the Licensor.
+ 
+In any circumstance, without the prior written consent of the Licensor, you are
+not allowed to use any Logo associated with the Licensor. If your use of
+Licensor's Logo in violation of this Agreement causes any losses to the Licensor
+or others, you will bear full legal responsibility.
+ 
+ 
+4. Disclaimer and Limitation of Liability
+
+The Yi Series Models are provided "AS IS." The Licensor does not provide any
+express or implied warranties for the Yi Series Models, including but not
+limited to stability, ownership, merchantability, non-infringement, or fitness
+for a specific purpose of the Yi Series Models and their output results. You
+assume all responsibilities for the risks and consequences arising from the use,
+reproduction, distribution of the Yi Series Models, and the creation of
+Derivatives.
+ 
+The Licensor complies with Laws and Regulations at all stages of model training,
+maintaining the legality, authenticity, accuracy, objectivity, and diversity of
+data and algorithms. The Licensor is not liable for any direct, indirect,
+incidental consequences, and other losses or damages related to your use,
+reproduction, and distribution of the Yi Series Models, and the creation of
+Derivatives under this Agreement. This includes but is not limited to:
+ 
+1) The Licensor is not responsible for data security risks resulting from your
+use of the Yi Series Models.
+ 
+2) The Yi Series Models may contain Personal Information. When you use Yi Series
+Models, you acknowledge that you are the data processing entity as defined under
+the Laws and Regulations responsible for determining the processing methods and
+purposes of Personal Information. You must comply with legal requirements for
+processing any Personal Information that may be contained in the Yi Series
+Models and assume the associated legal responsibilities, as well as the risks
+and consequences of processing Personal Information.
+ 
+3) The Licensor is not liable for reputation risks arising from your use of the
+Yi Series Models or the output results of the Yi Series Models.
+ 
+4) The Licensor is not liable for intellectual property risks associated with
+your use of the Yi Series Models’ output results.
+ 
+If your use, reproduction, distribution of the Yi Series Models, or the creation
+of Derivatives result in losses to the Licensor, the Licensor has the right to
+seek compensation from you. For any claims made by Third Parties against the
+Licensor related to your use, reproduction, and distribution of the Yi Series
+Models, or the creation of Derivatives, the Licensor has the right to demand
+that you defend, compensate, and indemnify the Licensor and protect the Licensor
+from harm.
+ 
+ 
+5. Dispute Resolution
+
+The stipulation, effectiveness, interpretation, performance, modification, and
+termination of the Agreement, the use, copy and Distribute of the Yi Series
+Models, and dispute resolution associated with your use, copy and distribution
+shall be governed by the laws of the mainland of the People's Republic of China
+(for the purposes of this agreement only, excluding Hong Kong, Macau, and
+Taiwan), and the application of conflict of laws is excluded.
+ 
+Any disputes arising from the use, copy or distribution of the Yi Series Models
+should first be resolved through amicable negotiations. If negotiations fail,
+legal proceedings should be initiated in the People's Court at the location of
+the Licensor.
+ 
+ 
+6. Effectiveness and Termination of the Agreement
+
+Your use of the Yi Series Models signifies that you have read and agreed to be
+bound by the terms of the Agreement. The Agreement becomes effective from the
+date of your use of the Yi Series Models and will terminate from the date you
+cease using the Yi Series Models. If you violate any terms or restrictions in
+the Agreement, the Licensor reserves the right to terminate the Agreement.
+ 
+Upon termination of the Agreement, you must immediately cease using the Yi
+Series Models. Section 4, "Disclaimer and Limitation of Liability," and Section
+5, "Dispute Resolution," of this Agreement remain in effect after the
+termination of this Agreement.
+ 
+ 
+7. Updates to the Agreement and Contact Information
+
+The Licensor reserves the right to update the Agreement from time to time. The
+latest version of the Agreement will be posted by the Licensor through
+https://01.ai.
+ 
+For any questions related to licensing and copyright, please contact the
+Licensor at yi@01.ai.
+
+
+
+                     Yi系列模型社区许可协议
+                          版本: 2.1
+                    发布日期: 2023年11月23日
+ 
+1. 定义
+
+“协议”是指本协议中定义Yi系列模型使用、复制和分发的条款和条件。
+
+“模型”是指任何附带的基于机器学习的组件(包括检查点)，包括学习的权重、参数（包括优
+化器状态）。
+
+“Yi系列模型”是指许可方开源的以Yi命名的不同规格、不同能力的模型，包括
+Yi-6B、Yi-34B等。
+
+“模型衍生品”是指对Yi系列模型的所有修改、基于Yi系列模型的工作，或通过将Yi系列模型
+的权重、参数、激活或输出模式转移到其他模型而创建或初始化的任何其他模型，以使其他
+模型的性能与Yi系列模型类似，包括但不限于需要使用中间数据表示的提取方法或基于Yi系
+列模型生成合成数据来训练其他模型的方法。
+
+“许可方”是指北京零一万物信息技术有限公司。
+
+“您”是指行使本协议授予的权限和/或出于任何目的和在任何使用领域使用Yi系列模型的个
+人或法人实体。
+ 
+“第三方”是指您之外的任何个人、法人实体或非法人组织。
+ 
+“分发”是指向第三方传输、复制、发布或以其他方式共享Yi系列模型，包括将Yi系列模型作
+为通过电子或其他远程方式（例如基于 API 或 Web 访问的任何 SaaS 软件或 PaaS 软
+件）提供。
+ 
+“商业用途”是指使用Yi系列模型，直接或间接为实体或个人进行运营、推广或产生收入，或
+用于任何其他盈利目的。
+ 
+“法律法规”是指中华人民共和国大陆地区（仅为本协议之目的，不包括香港、澳门和台湾）
+的法律及行政法规。
+ 
+“个人信息”是指以电子或者其他方式记录的与已识别或者可识别的自然人有关的各种信息，
+不包括匿名化处理后的信息。
+ 
+“标识” 是指任何商标、服务标记、商号、域名、网站名称或其他带有显著品牌特征的标记。
+ 
+ 
+2. 许可及许可限制
+
+许可方特此授予您非排他性、全球性、不可转让、不可再许可、可撤销、免版税的版权许可。
+您必须满足如下许可限制条件：
+ 
+1) 您对Yi系列模型的使用应遵守法律法规以及其他国家/地区适用的法律要求、尊重社会公
+德和伦理道德。包括但不限于您不得将Yi系列模型用作危害国家安全、宣扬恐怖主义、极端
+主义，宣扬民族及种族仇恨、歧视，暴力、色情，以及虚假有害信息等法律法规以及其他国
+家/地区适用的法律要求禁止的目的。
+ 
+2) 您不得出于军事或非法目的，或以法律法规以及其他国家/地区适用的法律要求所不允许
+的方式 a) 使用、复制、或分发Yi系列模型; 或 b) 创建Yi系列模型的全部或部分衍生品。
+ 
+3) 您对Yi系列模型的使用（包括使用Yi系列模型的输出）以及模型衍生品的创建不得侵犯
+任何第三方的合法权益，包括但不限于他人肖像权、名誉权、隐私权等人格权，著作权、专
+利权、商业秘密等知识产权，或其他财产权益。
+ 
+4) 您必须向Yi系列模型及Yi系列模型衍生品的任何第三方使用者明确Yi系列模型的来源为
+许可方并向其提供本协议的副本。
+ 
+5) 若您修改Yi系列模型得到模型衍生品，您必须以显著的方式说明修改的内容，且上述修
+改不得违反本协议的许可限制条件，也不能允许、协助或以其他方式使得第三方违反本协议
+中的许可限制条件。
+ 
+如果您计划将Yi系列模型及模型衍生品用作商业用途，请参见《Yi系列模型商用许可协议》
+（参见：https://www.lingyiwanwu.com/yi-license）附件一《Yi系列模型商用登
+记表》（“登记表”）并将填写完毕的登记表发送至 yi@01.ai 邮箱完成登记即可获得商用
+许可。若您获得商用许可并将Yi系列模型及模型衍生品用作商业用途，您应满足许可方上述
+许可限制条件及《Yi系列模型商用许可协议》中的商业许可限制。
+ 
+3. 知识产权
+
+Yi系列模型的所有权及其相关知识产权，由许可方单独所有。
+ 
+在任何情况下，未经许可方事先书面同意，您不得以任何方式使用许可方的任何标识。由于
+您违反本协议使用许可方的标识给许可方或他人造成损失的，由您承担全部法律责任。
+ 
+ 
+4. 免责声明及责任限制
+
+Yi系列模型按“原样”提供。许可方不对Yi系列模型提供任何明示或暗示的保证，包括但不限
+于：模型及输出结果的稳定性、所有权、适销性、非侵权性、或特定用途适用性。您将对适
+用、复制及分发Yi系列模型以及创建模型衍生品所产生的风险与后果承担所有责任。
+ 
+许可方在模型训练的所有阶段都遵守法律法规，坚持维护数据和算法的合法、真实、准确、
+客观和多样性。许可方不对您根据本协议使用、复制及分发Yi系列模型，以及创建模��衍生
+品而产生或与之相关的任何直接、间接、附带的后果、以及其他损失或损害承担责任。包括
+但不限于：
+ 
+1) 许可方不承担您因使用Yi系列模型而导致的数据安全风险。
+ 
+2) Yi系列模型中可能包含个人信息。在您使用Yi系列模型的过程中，您承认您为法律法规
+定义下决定个人信息处理方式和目的的个人信息处理者。您应遵守法律法规要求处理Yi系列
+模型中可能包含的个人信息，并承担相应的法律责任，以及处理个人信息的风险和后果。
+ 
+3) 许可方不承担您使用Yi系列模型或模型输出结果而产生的声誉风险。
+ 
+4) 许可方不承担您使用Yi系列模型的输出结果涉及的知识产权风险。
+ 
+若由于您对Yi系列模型的使用、复制或分发，或者创建模型衍生品而导致许可方遭受损失，
+许可方有权要求您对许可方的损失进行赔偿。对于任何第三方向许可方提出的因您使用、复
+制或分发Yi系列模型或创建模型衍生品行为的相关索赔，许可方有权要求您为许可方进行辩
+护、赔偿并使许可方免受损害。
+ 
+ 
+5. 争议解决
+
+协议的订立、效力、解释、履行、修改和终止，使用、复制和分发Yi系列模型以及争议解决
+均适用中华人民共和国大陆地区（仅为本协议之目的，不包括香港、澳门和台湾）法律，并
+排除冲突法的适用。
+ 
+因使用、复制和分发Yi系列模型而发生的任何争议，各方应首先通过友好协商的方式加以解
+决。协商不成时，应向许可方所在地人民法院提起诉讼。
+ 
+ 
+6. 协议的生效及终止
+
+您使用Yi系列模型即表示您已阅读并同意接受协议的约束。协议自您使用Yi系列模型之日起
+生效并将在您停止使用Yi系列模型之日起终止。若您违反协议中的任何条款或限制，许可方
+有权终止协议。
+ 
+若协议终止，您需立即停止使用Yi系列模型。本协议第4条“免责声明及责任限制”及第5条
+“争议解决”在协议终止后仍有效。
+ 
+ 
+7. 协议更新及联系方式
+
+许可方有权对协议进行不时更新。许可方将通过 https://01.ai 公布协议最新版本。有关
+许可和版权的任何问题，请通过 yi@01.ai 与许可方联系。

README.md

@@ -0,0 +1,1230 @@
+---
+license: other
+license_name: yi-license
+license_link: LICENSE
+widget:
+  - example_title: "Yi-34B-Chat"
+    text: "hi"
+    output:
+      text: " Hello! How can I assist you today?"
+  - example_title: "Yi-34B"
+    text: "There's a place where time stands still. A place of breath taking wonder, but also"
+    output:
+      text: " an eerie sense that something is just not right…\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 – 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’s get started now shall We?"
+pipeline_tag: text-generation
+---
+
+<div align="center">
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_dark.svg" width="200px">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_light.svg" width="200px"> 
+  <img alt="specify theme context for images" src="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_light.svg">
+</picture>
+
+</br>
+</br>
+
+<div style="display: inline-block;">
+<a href="https://github.com/01-ai/Yi/actions/workflows/build_docker_image.yml">
+  <img src="https://github.com/01-ai/Yi/actions/workflows/build_docker_image.yml/badge.svg">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a href="https://github.com/01-ai/Yi/blob/main/LICENSE">
+  <img src="https://img.shields.io/badge/Code_License-Apache_2.0-lightblue">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a href="https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt">
+  <img src="https://img.shields.io/badge/Model_License-Yi_License-lightblue">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a href="mailto:oss@01.ai">
+  <img src="https://img.shields.io/badge/✉️-yi@01.ai-FFE01B">
+</a>
+</div>
+
+</div>
+
+<div align="center">
+  <h3 align="center">Building the Next Generation of Open-Source and Bilingual LLMs</h3>
+</div>
+
+<p align="center">
+🤗 <a href="https://huggingface.co/01-ai" target="_blank">Hugging Face</a> • 🤖 <a href="https://www.modelscope.cn/organization/01ai/" target="_blank">ModelScope</a> • ✡️ <a href="https://wisemodel.cn/organization/01.AI" target="_blank">WiseModel</a>
+</p> 
+
+<p align="center">
+    👋 Join us 💬 <a href="https://github.com/01-ai/Yi/issues/43#issuecomment-1827285245" target="_blank"> WeChat (Chinese) </a>!
+</p> 
+
+
+<!-- DO NOT REMOVE ME -->
+
+<hr>
+
+<details open>
+<summary></b>📕 Table of Contents</b></summary>
+
+- [What is Yi?](#what-is-yi)
+  - [Introduction](#introduction)
+  - [Models](#models)
+    - [Chat models](#chat-models)
+    - [Base models](#base-models)
+    - [Other info](#other-info)
+  - [News](#news)
+- [How to use Yi?](#how-to-use-yi)
+  - [Quick start](#quick-start)
+    - [Choose your path](#choose-your-path)
+    - [pip](#quick-start---pip)
+    - [docker](#quick-start---docker)
+    - [llama.cpp](#quick-start---llamacpp)
+    - [conda-lock](#quick-start---conda-lock)
+    - [Web demo](#web-demo)
+  - [Fine-tuning](#fine-tuning)
+  - [Quantization](#quantization)
+  - [Deployment](#deployment)
+  - [Learning hub](#learning-hub)
+- [Why Yi?](#why-yi)
+  - [Ecosystem](#ecosystem)
+    - [Upstream](#upstream)
+    - [Downstream](#downstream)
+      - [Serving](#serving)
+      - [Quantization](#quantization-1)
+      - [Fine-tuning](#fine-tuning-1)
+      - [API](#api)
+  - [Benchmarks](#benchmarks)
+    - [Base model performance](#base-model-performance)
+    - [Chat model performance](#chat-model-performance)
+- [Who can use Yi?](#who-can-use-yi)
+- [Misc.](#misc)
+  - [Acknowledgements](#acknowledgments)
+  - [Disclaimer](#disclaimer)
+  - [License](#license)
+
+</details>
+
+<hr>
+
+# What is Yi?
+
+## Introduction 
+
+- 🤖 The Yi series models are the next generation of open-source large language models trained from scratch by [01.AI](https://01.ai/).
+
+- 🙌 Targeted as a bilingual language model and trained on 3T multilingual corpus, the Yi series models become one of the strongest LLM worldwide, showing promise in language understanding, commonsense reasoning, reading comprehension, and more. For example,
+  
+  - Yi-34B-Chat model **landed in second place (following GPT-4 Turbo)**, outperforming other LLMs (such as GPT-4, Mixtral, Claude) on the AlpacaEval Leaderboard (based on data available up to January 2024).
+ 
+  - Yi-34B model **ranked first among all existing open-source models** (such as Falcon-180B, Llama-70B, Claude) in **both English and Chinese** on various benchmarks, including Hugging Face Open LLM Leaderboard (pre-trained) and C-Eval (based on data available up to November 2023).
+  
+  - 🙏 (Credits to Llama) Thanks to the Transformer and Llama open-source communities, as they reduce the efforts required to build from scratch and enable the utilization of the same tools within the AI ecosystem.  
+
+  <details style="display: inline;"><summary> If you're interested in Yi's adoption of Llama architecture and license usage policy, see  <span style="color:  green;">Yi's relation with Llama.</span> ⬇️</summary> <ul> <br>
+  
+> 💡 TL;DR
+> 
+> The Yi series models adopt the same model architecture as Llama but are **NOT** derivatives of Llama.
+
+- Both Yi and Llama are all based on the Transformer structure, which has been the standard architecture for large language models since 2018.
+
+- Grounded in the Transformer architecture, Llama has become a new cornerstone for the majority of state-of-the-art open-source models due to its excellent stability, reliable convergence, and robust compatibility. This positions Llama as the recognized foundational framework for models including Yi.
+
+- Thanks to the Transformer and Llama architectures, other models can leverage their power, reducing the effort required to build from scratch and enabling the utilization of the same tools within their ecosystems.
+
+- However, the Yi series models are NOT derivatives of Llama, as they do not use Llama's weights.
+
+  - As Llama's structure is employed by the majority of open-source models, the key factors of determining model performance are training datasets, training pipelines, and training infrastructure.
+
+  - Developing in a unique and proprietary way, Yi has independently created its own high-quality training datasets, efficient training pipelines, and robust training infrastructure entirely from the ground up. This effort has led to excellent performance with Yi series models ranking just behind GPT4 and surpassing Llama on the [Alpaca Leaderboard in Dec 2023](https://tatsu-lab.github.io/alpaca_eval/). 
+</ul>
+</details>
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+## News 
+
+<details open>
+  <summary>🎯 <b>2024-03-06</b>: The <code>Yi-9B</code> is open-sourced and available to the public.</summary>
+  <br>
+<code>Yi-9B</code> stands out as the top performer among a range of similar-sized open-source models (including Mistral-7B, SOLAR-10.7B, Gemma-7B, DeepSeek-Coder-7B-Base-v1.5 and more), particularly excelling in code, math, common-sense reasoning, and reading comprehension.
+</details>
+
+<details open>
+  <summary>🎯 <b>2024-01-23</b>: The Yi-VL models, <code><a href="https://huggingface.co/01-ai/Yi-VL-34B">Yi-VL-34B</a></code> and <code><a href="https://huggingface.co/01-ai/Yi-VL-6B">Yi-VL-6B</a></code>, are open-sourced and available to the public.</summary>
+  <br>
+  <code><a href="https://huggingface.co/01-ai/Yi-VL-34B">Yi-VL-34B</a></code> has ranked <strong>first</strong> among all existing open-source models in the latest benchmarks, including <a href="https://arxiv.org/abs/2311.16502">MMMU</a> and <a href="https://arxiv.org/abs/2401.11944">CMMMU</a> (based on data available up to January 2024).</li>
+</details>
+
+
+<details>
+<summary>🎯 <b>2023-11-23</b>: <a href="#chat-models">Chat models</a> are open-sourced and available to the public.</summary>
+<br>This release contains two chat models based on previously released base models, two 8-bit models quantized by GPTQ, and two 4-bit models quantized by AWQ.
+
+- `Yi-34B-Chat`
+- `Yi-34B-Chat-4bits`
+- `Yi-34B-Chat-8bits`
+- `Yi-6B-Chat`
+- `Yi-6B-Chat-4bits`
+- `Yi-6B-Chat-8bits`
+
+You can try some of them interactively at:
+
+- [Hugging Face](https://huggingface.co/spaces/01-ai/Yi-34B-Chat)
+- [Replicate](https://replicate.com/01-ai)
+</details>
+
+<details>
+  <summary>🔔 <b>2023-11-23</b>: The Yi Series Models Community License Agreement is updated to <a href="https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt">v2.1</a>.</summary>
+</details>
+
+<details> 
+<summary>🔥 <b>2023-11-08</b>: Invited test of Yi-34B chat model.</summary>
+<br>Application form:
+
+- [English](https://cn.mikecrm.com/l91ODJf)
+- [Chinese](https://cn.mikecrm.com/gnEZjiQ)
+</details>
+
+<details>
+<summary>🎯 <b>2023-11-05</b>: <a href="#base-models">The base models, </a><code>Yi-6B-200K</code> and <code>Yi-34B-200K</code>, are open-sourced and available to the public.</summary>
+<br>This release contains two base models with the same parameter sizes as the previous
+release, except that the context window is extended to 200K.
+</details>
+
+<details>
+<summary>🎯 <b>2023-11-02</b>: <a href="#base-models">The base models, </a><code>Yi-6B</code> and <code>Yi-34B</code>, are open-sourced and available to the public.</summary>
+<br>The first public release contains two bilingual (English/Chinese) base models
+with the parameter sizes of 6B and 34B.  Both of them are trained with 4K
+sequence length and can be extended to 32K during inference time.
+
+</details>
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+## Models
+
+Yi models come in multiple sizes and cater to different use cases. You can also fine-tune Yi models to meet your specific requirements. 
+
+If you want to deploy Yi models, make sure you meet the [software and hardware requirements](#deployment).
+
+### Chat models
+
+| Model | Download  
+|---|---
+Yi-34B-Chat	| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-34B-Chat)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-34B-Chat/summary)
+Yi-34B-Chat-4bits	| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-34B-Chat-4bits)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-34B-Chat-4bits/summary)
+Yi-34B-Chat-8bits | • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-34B-Chat-8bits) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-34B-Chat-8bits/summary)
+Yi-6B-Chat| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-6B-Chat) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-6B-Chat/summary)
+Yi-6B-Chat-4bits |	• [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-6B-Chat-4bits)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-6B-Chat-4bits/summary)
+Yi-6B-Chat-8bits	|  • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-6B-Chat-8bits) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-6B-Chat-8bits/summary)
+
+
+<sub><sup> - 4-bit series models are quantized by AWQ. <br> - 8-bit series models are quantized by GPTQ <br> - All quantized models have a low barrier to use since they can be deployed on consumer-grade GPUs (e.g., 3090, 4090). </sup></sub>
+
+### Base models
+
+| Model | Download | 
+|---|---|
+Yi-34B| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-34B)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-34B/summary)
+Yi-34B-200K|• [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-34B-200K)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-34B-200K/summary)
+Yi-9B|• [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-9B)
+Yi-6B| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-6B)  • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-6B/summary)
+Yi-6B-200K	| • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-6B-200K) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-6B-200K/summary)
+
+<sub><sup> - 200k is roughly equivalent to 400,000 Chinese characters.  </sup></sub>
+
+### Model info
+
+- For chat and base models
+
+Model | Intro | Default context window | Pretrained tokens | Training Data Date
+|---|---|---|---|---
+6B series models |They are suitable for personal and academic use. | 4K | 3T | Up to June 2023
+9B model| It is the best at coding and math in the Yi series models.|4K | Yi-9B is continuously trained based on Yi-6B, using 0.8T tokens. |  Up to June 2023
+34B series models | They are suitable for personal, academic, and commercial (particularly for small and medium-sized enterprises) purposes. It's a cost-effective solution that's affordable and equipped with emergent ability.|4K | 3T | Up to June 2023
+
+- For chat models
+  
+  <details style="display: inline;"><summary>For chat model limitations, see the explanations below. ⬇️</summary>
+   <ul>
+    <br>The released chat model has undergone exclusive training using Supervised Fine-Tuning (SFT). Compared to other standard chat models, our model produces more diverse responses, making it suitable for various downstream tasks, such as creative scenarios. Furthermore, this diversity is expected to enhance the likelihood of generating higher quality responses, which will be advantageous for subsequent Reinforcement Learning (RL) training.
+
+    <br>However, this higher diversity might amplify certain existing issues, including:
+      <li>Hallucination: This refers to the model generating factually incorrect or nonsensical information. With the model's responses being more varied, there's a higher chance of hallucination that are not based on accurate data or logical reasoning.</li>
+      <li>Non-determinism in re-generation: When attempting to regenerate or sample responses, inconsistencies in the outcomes may occur. The increased diversity can lead to varying results even under similar input conditions.</li>
+      <li>Cumulative Error: This occurs when errors in the model's responses compound over time. As the model generates more diverse responses, the likelihood of small inaccuracies building up into larger errors increases, especially in complex tasks like extended reasoning, mathematical problem-solving, etc.</li>
+      <li>To achieve more coherent and consistent responses, it is advisable to adjust generation configuration parameters such as temperature, top_p, or top_k. These adjustments can help in the balance between creativity and coherence in the model's outputs.</li>
+</ul>
+</details>
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+
+# How to use Yi?
+
+- [Quick start](#quick-start)
+  - [Choose your path](#choose-your-path)
+  - [pip](#quick-start---pip)
+  - [docker](#quick-start---docker)
+  - [conda-lock](#quick-start---conda-lock)
+  - [llama.cpp](#quick-start---llamacpp)
+  - [Web demo](#web-demo)
+- [Fine-tuning](#fine-tuning)
+- [Quantization](#quantization)
+- [Deployment](#deployment)
+- [Learning hub](#learning-hub)
+
+## Quick start
+
+Getting up and running with Yi models is simple with multiple choices available. 
+
+### Choose your path
+
+Select one of the following paths to begin your journey with Yi!
+
+ ![Quick start - Choose your path](https://github.com/01-ai/Yi/blob/main/assets/img/quick_start_path.png?raw=true)
+
+#### 🎯 Deploy Yi locally
+
+If you prefer to deploy Yi models locally, 
+
+  - 🙋‍♀️ and you have **sufficient** resources (for example, NVIDIA A800 80GB), you can choose one of the following methods:
+    - [pip](#quick-start---pip)
+    - [Docker](#quick-start---docker)
+    - [conda-lock](#quick-start---conda-lock)
+
+  - 🙋‍♀️ and you have **limited** resources (for example, a MacBook Pro), you can use [llama.cpp](#quick-start---llamacpp).
+
+#### 🎯 Not to deploy Yi locally
+
+If you prefer not to deploy Yi models locally, you can explore Yi's capabilities using any of the following options.
+
+##### 🙋‍♀️ Run Yi with APIs
+
+If you want to explore more features of Yi, you can adopt one of these methods:
+
+- Yi APIs (Yi official)
+  - [Early access has been granted](https://x.com/01AI_Yi/status/1735728934560600536?s=20) to some applicants. Stay tuned for the next round of access!
+
+- [Yi APIs](https://replicate.com/01-ai/yi-34b-chat/api?tab=nodejs) (Replicate)
+
+##### 🙋‍♀️ Run Yi in playground
+
+If you want to chat with Yi with more customizable options (e.g., system prompt, temperature, repetition penalty, etc.), you can try one of the following options:
+  
+  - [Yi-34B-Chat-Playground](https://platform.lingyiwanwu.com/prompt/playground) (Yi official)
+    - Access is available through a whitelist. Welcome to apply (fill out a form in [English](https://cn.mikecrm.com/l91ODJf) or [Chinese](https://cn.mikecrm.com/gnEZjiQ)).
+  
+  - [Yi-34B-Chat-Playground](https://replicate.com/01-ai/yi-34b-chat) (Replicate) 
+
+##### 🙋‍♀️ Chat with Yi
+
+ If you want to chat with Yi, you can use one of these online services, which offer a similar user experience:
+
+- [Yi-34B-Chat](https://huggingface.co/spaces/01-ai/Yi-34B-Chat) (Yi official on Hugging Face)
+  - No registration is required.
+
+- [Yi-34B-Chat](https://platform.lingyiwanwu.com/) (Yi official beta)
+  - Access is available through a whitelist. Welcome to apply (fill out a form in [English](https://cn.mikecrm.com/l91ODJf) or [Chinese](https://cn.mikecrm.com/gnEZjiQ)).
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Quick start - pip 
+
+This tutorial guides you through every step of running **Yi-34B-Chat locally on an A800 (80G)** and then performing inference.
+
+#### Step 0: Prerequisites
+ 
+- Make sure Python 3.10 or a later version is installed.
+
+- If you want to run other Yi models, see [software and hardware requirements](#deployment).
+
+#### Step 1: Prepare your environment 
+
+To set up the environment and install the required packages, execute the following command.
+
+```bash
+git clone https://github.com/01-ai/Yi.git
+cd yi
+pip install -r requirements.txt
+```
+
+#### Step 2: Download the Yi model
+
+You can download the weights and tokenizer of Yi models from the following sources:
+
+- [Hugging Face](https://huggingface.co/01-ai)
+- [ModelScope](https://www.modelscope.cn/organization/01ai/)
+- [WiseModel](https://wisemodel.cn/organization/01.AI)
+
+#### Step 3: Perform inference
+
+You can perform inference with Yi chat or base models as below.
+
+##### Perform inference with Yi chat model
+
+1. Create a file named  `quick_start.py` and copy the following content to it.
+
+    ```python
+    from transformers import AutoModelForCausalLM, AutoTokenizer
+
+    model_path = '<your-model-path>'
+
+    tokenizer = AutoTokenizer.from_pretrained(model_path, use_fast=False)
+
+    # Since transformers 4.35.0, the GPT-Q/AWQ model can be loaded using AutoModelForCausalLM.
+    model = AutoModelForCausalLM.from_pretrained(
+        model_path,
+        device_map="auto",
+        torch_dtype='auto'
+    ).eval()
+
+    # Prompt content: "hi"
+    messages = [
+        {"role": "user", "content": "hi"}
+    ]
+
+    input_ids = tokenizer.apply_chat_template(conversation=messages, tokenize=True, add_generation_prompt=True, return_tensors='pt')
+    output_ids = model.generate(input_ids.to('cuda'))
+    response = tokenizer.decode(output_ids[0][input_ids.shape[1]:], skip_special_tokens=True)
+
+    # Model response: "Hello! How can I assist you today?"
+    print(response)
+    ```
+
+2. Run `quick_start.py`.
+
+    ```bash
+    python quick_start.py
+    ```
+
+    Then you can see an output similar to the one below. 🥳
+
+    ```bash
+    Hello! How can I assist you today?
+    ```
+
+##### Perform inference with Yi base model
+
+- Yi-34B
+
+  The steps are similar to [pip - Perform inference with Yi chat model](#perform-inference-with-yi-chat-model).
+
+  You can use the existing file [`text_generation.py`](https://github.com/01-ai/Yi/tree/main/demo).
+
+  ```bash
+  python demo/text_generation.py  --model <your-model-path>
+  ```
+
+  Then you can see an output similar to the one below. 🥳
+
+  <details>
+
+  <summary>Output. ⬇️ </summary>
+
+  <br>
+
+  **Prompt**: Let me tell you an interesting story about cat Tom and mouse Jerry,
+
+  **Generation**: Let me tell you an interesting story about cat Tom and mouse Jerry, which happened in my childhood. My father had a big house with two cats living inside it to kill mice. One day when I was playing at home alone, I found one of the tomcats lying on his back near our kitchen door, looking very much like he wanted something from us but couldn’t get up because there were too many people around him! He kept trying for several minutes before finally giving up...
+
+  </details>
+
+- Yi-9B
+  
+  Input
+
+  ```bash
+  from transformers import AutoModelForCausalLM, AutoTokenizer
+
+  MODEL_DIR = "01-ai/Yi-9B"
+  model = AutoModelForCausalLM.from_pretrained(MODEL_DIR, torch_dtype="auto")
+  tokenizer = AutoTokenizer.from_pretrained(MODEL_DIR, use_fast=False)
+
+  input_text = "# write the quick sort algorithm"
+  inputs = tokenizer(input_text, return_tensors="pt").to(model.device)
+  outputs = model.generate(**inputs, max_length=256)
+  print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+  ```
+
+  Output
+
+  ```bash
+  # write the quick sort algorithm
+  def quick_sort(arr):
+      if len(arr) <= 1:
+          return arr
+      pivot = arr[len(arr) // 2]
+      left = [x for x in arr if x < pivot]
+      middle = [x for x in arr if x == pivot]
+      right = [x for x in arr if x > pivot]
+      return quick_sort(left) + middle + quick_sort(right)
+
+  # test the quick sort algorithm
+  print(quick_sort([3, 6, 8, 10, 1, 2, 1]))
+  ```
+
+    <p align="right"> [
+    <a href="#top">Back to top ⬆️ </a>  ] 
+  </p>
+
+### Quick start - Docker 
+<details>
+<summary> Run Yi-34B-chat locally with Docker: a step-by-step guide. ⬇️</summary> 
+<br>This tutorial guides you through every step of running <strong>Yi-34B-Chat on an A800 GPU</strong> or <strong>4*4090</strong> locally and then performing inference.
+ <h4>Step 0: Prerequisites</h4>
+<p>Make sure you've installed <a href="https://docs.docker.com/engine/install/?open_in_browser=true">Docker</a> and <a href="https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html">nvidia-container-toolkit</a>.</p>
+
+<h4> Step 1: Start Docker </h4>
+<pre><code>docker run -it --gpus all \
+-v &lt;your-model-path&gt;: /models
+ghcr.io/01-ai/yi:latest
+</code></pre>
+<p>Alternatively, you can pull the Yi Docker image from <code>registry.lingyiwanwu.com/ci/01-ai/yi:latest</code>.</p>
+
+<h4>Step 2: Perform inference</h4>
+    <p>You can perform inference with Yi chat or base models as below.</p>
+    
+<h5>Perform inference with Yi chat model</h5>
+    <p>The steps are similar to <a href="#perform-inference-with-yi-chat-model">pip - Perform inference with Yi chat model</a>.</p>
+    <p><strong>Note</strong> that the only difference is to set <code>model_path = '&lt;your-model-mount-path&gt;'</code> instead of <code>model_path = '&lt;your-model-path&gt;'</code>.</p>
+<h5>Perform inference with Yi base model</h5>
+    <p>The steps are similar to <a href="#perform-inference-with-yi-base-model">pip - Perform inference with Yi base model</a>.</p>
+    <p><strong>Note</strong> that the only difference is to set <code>--model &lt;your-model-mount-path&gt;'</code> instead of <code>model &lt;your-model-path&gt;</code>.</p>
+</details>
+
+### Quick start - conda-lock
+
+<details>
+<summary>You can use <code><a href="https://github.com/conda/conda-lock">conda-lock</a></code> to generate fully reproducible lock files for conda environments. ⬇️</summary>
+<br>
+You can refer to <a href="https://github.com/01-ai/Yi/blob/ebba23451d780f35e74a780987ad377553134f68/conda-lock.yml">conda-lock.yml</a>  for the exact versions of the dependencies. Additionally, you can utilize <code><a href="https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html">micromamba</a></code> for installing these dependencies.
+<br>
+To install the dependencies, follow these steps:
+
+1. Install micromamba by following the instructions available <a href="https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html">here</a>.
+
+2. Execute <code>micromamba install -y -n yi -f conda-lock.yml</code> to create a conda environment named <code>yi</code> and install the necessary dependencies.
+</details>
+
+
+### Quick start - llama.cpp
+<details>
+<summary> Run Yi-chat-6B-2bits locally with llama.cpp: a step-by-step guide. ⬇️</summary> 
+<br>This tutorial guides you through every step of running a quantized model (<a href="https://huggingface.co/XeIaso/yi-chat-6B-GGUF/tree/main">Yi-chat-6B-2bits</a>) locally and then performing inference.</p>
+
+- [Step 0: Prerequisites](#step-0-prerequisites)
+- [Step 1: Download llama.cpp](#step-1-download-llamacpp)
+- [Step 2: Download Yi model](#step-2-download-yi-model)
+- [Step 3: Perform inference](#step-3-perform-inference)
+
+#### Step 0: Prerequisites 
+
+- This tutorial assumes you use a MacBook Pro with 16GB of memory and an Apple M2 Pro chip.
+  
+- Make sure [`git-lfs`](https://git-lfs.com/) is installed on your machine.
+  
+#### Step 1: Download `llama.cpp`
+
+To clone the [`llama.cpp`](https://github.com/ggerganov/llama.cpp) repository, run the following command.
+
+```bash
+git clone git@github.com:ggerganov/llama.cpp.git
+```
+
+#### Step 2: Download Yi model
+
+2.1 To clone [XeIaso/yi-chat-6B-GGUF](https://huggingface.co/XeIaso/yi-chat-6B-GGUF/tree/main) with just pointers, run the following command.
+
+```bash
+GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/XeIaso/yi-chat-6B-GGUF
+```
+
+2.2 To download a quantized Yi model ([yi-chat-6b.Q2_K.gguf](https://huggingface.co/XeIaso/yi-chat-6B-GGUF/blob/main/yi-chat-6b.Q2_K.gguf)), run the following command.
+
+```bash
+git-lfs pull --include yi-chat-6b.Q2_K.gguf
+```
+
+#### Step 3: Perform inference
+
+To perform inference with the Yi model, you can use one of the following methods.
+
+- [Method 1: Perform inference in terminal](#method-1-perform-inference-in-terminal)
+  
+- [Method 2: Perform inference in web](#method-2-perform-inference-in-web)
+
+##### Method 1: Perform inference in terminal
+
+To compile `llama.cpp` using 4 threads and then conduct inference, navigate to the `llama.cpp` directory, and run the following command.
+
+> ##### Tips
+> 
+> - Replace `/Users/yu/yi-chat-6B-GGUF/yi-chat-6b.Q2_K.gguf` with the actual path of your model.
+>
+> - By default, the model operates in completion mode.
+> 
+> - For additional output customization options (for example, system prompt, temperature, repetition penalty, etc.), run `./main -h` to check detailed descriptions and usage.
+
+```bash
+make -j4 && ./main -m /Users/yu/yi-chat-6B-GGUF/yi-chat-6b.Q2_K.gguf -p "How do you feed your pet fox? Please answer this question in 6 simple steps:\nStep 1:" -n 384 -e
+
+...
+
+How do you feed your pet fox? Please answer this question in 6 simple steps:
+
+Step 1: Select the appropriate food for your pet fox. You should choose high-quality, balanced prey items that are suitable for their unique dietary needs. These could include live or frozen mice, rats, pigeons, or other small mammals, as well as fresh fruits and vegetables.
+
+Step 2: Feed your pet fox once or twice a day, depending on the species and its individual preferences. Always ensure that they have access to fresh water throughout the day.
+
+Step 3: Provide an appropriate environment for your pet fox. Ensure it has a comfortable place to rest, plenty of space to move around, and opportunities to play and exercise.
+
+Step 4: Socialize your pet with other animals if possible. Interactions with other creatures can help them develop social skills and prevent boredom or stress.
+
+Step 5: Regularly check for signs of illness or discomfort in your fox. Be prepared to provide veterinary care as needed, especially for common issues such as parasites, dental health problems, or infections.
+
+Step 6: Educate yourself about the needs of your pet fox and be aware of any potential risks or concerns that could affect their well-being. Regularly consult with a veterinarian to ensure you are providing the best care.
+
+...
+
+```
+
+Now you have successfully asked a question to the Yi model and got an answer! 🥳
+
+##### Method 2: Perform inference in web
+
+1. To initialize a lightweight and swift chatbot, run the following command.
+
+    ```bash
+    cd llama.cpp
+    ./server --ctx-size 2048 --host 0.0.0.0 --n-gpu-layers 64 --model /Users/yu/yi-chat-6B-GGUF/yi-chat-6b.Q2_K.gguf
+    ```
+
+    Then you can get an output like this:
+
+
+    ```bash
+    ...
+
+    llama_new_context_with_model: n_ctx      = 2048
+    llama_new_context_with_model: freq_base  = 5000000.0
+    llama_new_context_with_model: freq_scale = 1
+    ggml_metal_init: allocating
+    ggml_metal_init: found device: Apple M2 Pro
+    ggml_metal_init: picking default device: Apple M2 Pro
+    ggml_metal_init: ggml.metallib not found, loading from source
+    ggml_metal_init: GGML_METAL_PATH_RESOURCES = nil
+    ggml_metal_init: loading '/Users/yu/llama.cpp/ggml-metal.metal'
+    ggml_metal_init: GPU name:   Apple M2 Pro
+    ggml_metal_init: GPU family: MTLGPUFamilyApple8 (1008)
+    ggml_metal_init: hasUnifiedMemory              = true
+    ggml_metal_init: recommendedMaxWorkingSetSize  = 11453.25 MB
+    ggml_metal_init: maxTransferRate               = built-in GPU
+    ggml_backend_metal_buffer_type_alloc_buffer: allocated buffer, size =   128.00 MiB, ( 2629.44 / 10922.67)
+    llama_new_context_with_model: KV self size  =  128.00 MiB, K (f16):   64.00 MiB, V (f16):   64.00 MiB
+    ggml_backend_metal_buffer_type_alloc_buffer: allocated buffer, size =     0.02 MiB, ( 2629.45 / 10922.67)
+    llama_build_graph: non-view tensors processed: 676/676
+    llama_new_context_with_model: compute buffer total size = 159.19 MiB
+    ggml_backend_metal_buffer_type_alloc_buffer: allocated buffer, size =   156.02 MiB, ( 2785.45 / 10922.67)
+    Available slots:
+    -> Slot 0 - max context: 2048
+
+    llama server listening at http://0.0.0.0:8080
+    ```
+
+2. To access the chatbot interface, open your web browser and enter `http://0.0.0.0:8080` into the address bar. 
+   
+    ![Yi model chatbot interface - llama.cpp](https://github.com/01-ai/Yi/blob/main/assets/img/yi_llama_cpp1.png?raw=true)
+
+
+3. Enter a question, such as "How do you feed your pet fox? Please answer this question in 6 simple steps" into the prompt window, and you will receive a corresponding answer.
+
+    ![Ask a question to Yi model - llama.cpp](https://github.com/01-ai/Yi/blob/main/assets/img/yi_llama_cpp2.png?raw=true)
+
+</ul>
+</details>
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Web demo
+
+You can build a web UI demo for Yi **chat** models (note that Yi base models are not supported in this senario).
+
+[Step 1: Prepare your environment](#step-1-prepare-your-environment). 
+
+[Step 2: Download the Yi model](#step-2-download-the-yi-model).
+
+Step 3. To start a web service locally, run the following command.
+
+```bash
+python demo/web_demo.py -c <your-model-path>
+```
+
+You can access the web UI by entering the address provided in the console into your browser. 
+
+ ![Quick start - web demo](https://github.com/01-ai/Yi/blob/main/assets/img/yi_34b_chat_web_demo.gif?raw=true)
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Fine-tuning
+
+```bash
+bash finetune/scripts/run_sft_Yi_6b.sh
+```
+
+Once finished, you can compare the finetuned model and the base model with the following command:
+
+```bash
+bash finetune/scripts/run_eval.sh
+```
+<details style="display: inline;"><summary>For advanced usage (like fine-tuning based on your custom data), see the explanations below. ⬇️ </summary> <ul>
+
+### Finetune code for Yi 6B and 34B
+
+#### Preparation
+
+##### From Image
+
+By default, we use a small dataset from [BAAI/COIG](https://huggingface.co/datasets/BAAI/COIG) to finetune the base model.
+You can also prepare your customized dataset in the following `jsonl` format:
+
+```json
+{ "prompt": "Human: Who are you? Assistant:", "chosen": "I'm Yi." }
+```
+
+And then mount them in the container to replace the default ones:
+
+```bash
+docker run -it \
+    -v /path/to/save/finetuned/model/:/finetuned-model \
+    -v /path/to/train.jsonl:/yi/finetune/data/train.json \
+    -v /path/to/eval.jsonl:/yi/finetune/data/eval.json \
+    ghcr.io/01-ai/yi:latest \
+    bash finetune/scripts/run_sft_Yi_6b.sh
+```
+
+##### From Local Server
+
+Make sure you have conda. If not, use
+
+```bash
+mkdir -p ~/miniconda3
+wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
+bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
+rm -rf ~/miniconda3/miniconda.sh
+~/miniconda3/bin/conda init bash
+source ~/.bashrc
+```
+
+Then, create a conda env:
+
+```bash
+conda create -n dev_env python=3.10 -y
+conda activate dev_env
+pip install torch==2.0.1 deepspeed==0.10 tensorboard transformers datasets sentencepiece accelerate ray==2.7
+```
+
+#### Hardware Setup
+
+For the Yi-6B model, a node with 4 GPUs, each has GPU mem larger than 60GB is recommended.
+
+For the Yi-34B model, because the usage of zero-offload technique takes a lot CPU memory, please be careful to limit the GPU numbers in 34B finetune training. Please use CUDA_VISIBLE_DEVICES to limit the GPU number (as shown in scripts/run_sft_Yi_34b.sh).
+
+A typical hardware setup for finetuning 34B model is a node with 8GPUS (limit to 4 in running by CUDA_VISIBLE_DEVICES=0,1,2,3), each has GPU mem larger than 80GB, with total CPU mem larger than 900GB.
+
+#### Quick Start
+
+Download a LLM-base model to MODEL_PATH (6B and 34B). A typical folder of models is like:
+
+```bash
+|-- $MODEL_PATH
+|   |-- config.json
+|   |-- pytorch_model-00001-of-00002.bin
+|   |-- pytorch_model-00002-of-00002.bin
+|   |-- pytorch_model.bin.index.json
+|   |-- tokenizer_config.json
+|   |-- tokenizer.model
+|   |-- ...
+```
+
+Download a dataset from huggingface to local storage DATA_PATH, e.g. Dahoas/rm-static.
+
+```bash
+|-- $DATA_PATH
+|   |-- data
+|   |   |-- train-00000-of-00001-2a1df75c6bce91ab.parquet
+|   |   |-- test-00000-of-00001-8c7c51afc6d45980.parquet
+|   |-- dataset_infos.json
+|   |-- README.md
+```
+
+`finetune/yi_example_dataset` has example datasets, which are modified from [BAAI/COIG](https://huggingface.co/datasets/BAAI/COIG)
+
+```bash
+|-- $DATA_PATH
+    |--data
+        |-- train.jsonl
+        |-- eval.jsonl
+```
+
+`cd` into the scripts folder, copy and paste the script, and run. For example:
+
+```bash
+cd finetune/scripts
+
+bash run_sft_Yi_6b.sh
+```
+
+For the Yi-6B base model, setting training_debug_steps=20 and num_train_epochs=4 can output a chat model, which takes about 20 minutes.
+
+For the Yi-34B base model, it takes a relatively long time for initialization. Please be patient.
+
+#### Evaluation
+
+```bash
+cd finetune/scripts
+
+bash run_eval.sh
+```
+
+Then you'll see the answer from both the base model and the finetuned model.
+</ul>
+</details>
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Quantization
+
+#### GPT-Q
+```bash
+python quantization/gptq/quant_autogptq.py \
+  --model /base_model                      \
+  --output_dir /quantized_model            \
+  --trust_remote_code
+```
+
+Once finished, you can then evaluate the resulting model as follows:
+
+```bash
+python quantization/gptq/eval_quantized_model.py \
+  --model /quantized_model                       \
+  --trust_remote_code
+```
+
+<details style="display: inline;"><summary>For a more detailed explanation, see the explanations below. ⬇️</summary> <ul>
+
+#### GPT-Q quantization
+
+[GPT-Q](https://github.com/IST-DASLab/gptq) is a PTQ(Post-Training Quantization)
+method. It's memory saving and provides potential speedups while retaining the accuracy
+of the model. 
+
+Yi models can be GPT-Q quantized without a lot of efforts. 
+We provide a step-by-step tutorial below.
+
+To run GPT-Q, we will use [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) and
+[exllama](https://github.com/turboderp/exllama).
+And the huggingface transformers has integrated optimum and auto-gptq to perform
+GPTQ quantization on language models.
+
+##### Do Quantization
+
+The `quant_autogptq.py` script is provided for you to perform GPT-Q quantization:
+
+```bash
+python quant_autogptq.py --model /base_model \
+    --output_dir /quantized_model --bits 4 --group_size 128 --trust_remote_code
+```
+
+
+##### Run Quantized Model
+
+You can run a quantized model using the `eval_quantized_model.py`:
+
+```bash
+python eval_quantized_model.py --model /quantized_model --trust_remote_code
+```
+</ul>
+</details>
+
+#### AWQ
+```bash
+python quantization/awq/quant_autoawq.py \
+  --model /base_model                      \
+  --output_dir /quantized_model            \
+  --trust_remote_code
+```
+
+Once finished, you can then evaluate the resulting model as follows:
+
+```bash
+python quantization/awq/eval_quantized_model.py \
+  --model /quantized_model                       \
+  --trust_remote_code
+```
+<details style="display: inline;"><summary>For detailed explanations, see the explanations below. ⬇️</summary> <ul>
+
+#### AWQ quantization
+
+[AWQ](https://github.com/mit-han-lab/llm-awq) is a PTQ(Post-Training Quantization)
+method. It's an efficient and accurate low-bit weight quantization (INT3/4) for LLMs.
+
+Yi models can be AWQ quantized without a lot of efforts. 
+We provide a step-by-step tutorial below.
+
+To run AWQ, we will use [AutoAWQ](https://github.com/casper-hansen/AutoAWQ).
+
+##### Do Quantization
+
+The `quant_autoawq.py` script is provided for you to perform AWQ quantization:
+
+```bash
+python quant_autoawq.py --model /base_model \
+    --output_dir /quantized_model --bits 4 --group_size 128 --trust_remote_code
+```
+
+##### Run Quantized Model
+
+You can run a quantized model using the `eval_quantized_model.py`:
+
+```bash
+python eval_quantized_model.py --model /quantized_model --trust_remote_code
+```
+
+
+</ul>
+</details>
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Deployment
+
+If you want to deploy Yi models, make sure you meet the software and hardware requirements. 
+
+#### Software requirements
+
+Before using Yi quantized models, make sure you've installed the correct software listed below.
+
+| Model | Software
+|---|---
+Yi 4-bit quantized models | [AWQ and CUDA](https://github.com/casper-hansen/AutoAWQ?tab=readme-ov-file#install-from-pypi)
+Yi 8-bit quantized models |  [GPTQ and CUDA](https://github.com/PanQiWei/AutoGPTQ?tab=readme-ov-file#quick-installation)
+
+#### Hardware requirements
+
+Before deploying Yi in your environment, make sure your hardware meets the following requirements.
+
+##### Chat models
+
+| Model                | Minimum VRAM |        Recommended GPU Example       |
+|----------------------|--------------|:-------------------------------------:|
+| Yi-6B-Chat           | 15 GB         | 1 x RTX 3090 <br> 1 x RTX 4090 <br>  A10 <br> A30             |
+| Yi-6B-Chat-4bits     | 4 GB          | 1 x RTX 3060 <br>  1 x RTX 4060                     |
+| Yi-6B-Chat-8bits     | 8 GB          | 1 x RTX 3070 <br> 1 x RTX 4060                     |
+| Yi-34B-Chat          | 72 GB         | 4 x RTX 4090 <br> A800 (80GB)               |
+| Yi-34B-Chat-4bits    | 20 GB         | 1 x RTX 3090  <br> 1 x RTX 4090 <br> A10 <br> A30 <br> A100 (40GB) |
+| Yi-34B-Chat-8bits    | 38 GB         | 2 x RTX 3090  <br> 2 x RTX 4090 <br> A800  (40GB) |
+
+Below are detailed minimum VRAM requirements under different batch use cases.
+
+|  Model                  | batch=1 | batch=4 | batch=16 | batch=32 |
+| ----------------------- | ------- | ------- | -------- | -------- |
+| Yi-6B-Chat              | 12 GB   | 13 GB   | 15 GB    | 18 GB    |
+| Yi-6B-Chat-4bits  | 4 GB    | 5 GB    | 7 GB     | 10 GB    |
+| Yi-6B-Chat-8bits  | 7 GB    | 8 GB    | 10 GB    | 14 GB    |
+| Yi-34B-Chat       | 65 GB   | 68 GB   | 76 GB    | > 80 GB   |
+| Yi-34B-Chat-4bits | 19 GB   | 20 GB   | 30 GB    | 40 GB    |
+| Yi-34B-Chat-8bits | 35 GB   | 37 GB   | 46 GB    | 58 GB    |
+
+##### Base models
+
+| Model                | Minimum VRAM |        Recommended GPU Example       |
+|----------------------|--------------|:-------------------------------------:|
+| Yi-6B                | 15 GB         | 1 x RTX 3090 <br> 1 x RTX 4090 <br> A10 <br> A30               |
+| Yi-6B-200K           | 50 GB         | A800 (80 GB)                            |
+| Yi-9B                | 20 GB         | 1 x RTX 4090 (24 GB)                           |
+| Yi-34B               | 72 GB         | 4 x RTX 4090 <br> A800 (80 GB)               |
+| Yi-34B-200K          | 200 GB        | 4 x A800 (80 GB)                        |
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Learning hub
+
+<details>
+<summary> If you want to learn Yi, you can find a wealth of helpful educational resources here. ⬇️</summary> 
+<br> 
+  
+Welcome to the Yi learning hub! 
+
+Whether you're a seasoned developer or a newcomer, you can find a wealth of helpful educational resources to enhance your understanding and skills with Yi models, including insightful blog posts, comprehensive video tutorials, hands-on guides, and more.  
+
+The content you find here has been generously contributed by knowledgeable Yi experts and passionate enthusiasts. We extend our heartfelt gratitude for your invaluable contributions! 
+
+At the same time, we also warmly invite you to join our collaborative effort by contributing to Yi. If you have already made contributions to Yi, please don't hesitate to showcase your remarkable work in the table below.
+
+With all these resources at your fingertips, you're ready to start your exciting journey with Yi. Happy learning! 🥳
+
+#### Tutorials
+##### English tutorials
+| Type        | Deliverable                                            |      Date      |     Author     |
+|-------------|--------------------------------------------------------|----------------|----------------|
+| Video     | [Run dolphin-2.2-yi-34b on IoT Devices](https://www.youtube.com/watch?v=NJ89T5mO25Y)           |  2023-11-30  |  [Second State](https://github.com/second-state)  |
+| Blog        | [Running Yi-34B-Chat locally using LlamaEdge](https://www.secondstate.io/articles/yi-34b/)                   |  2023-11-30  |  [Second State](https://github.com/second-state)  |
+| Video       | [Install Yi 34B Locally - Chinese English Bilingual LLM](https://www.youtube.com/watch?v=CVQvj4Wrh4w&t=476s) | 2023-11-05  |  [Fahd Mirza](https://www.youtube.com/@fahdmirza)  |
+| Video       | [Dolphin Yi 34b - Brand New Foundational Model TESTED](https://www.youtube.com/watch?v=On3Zuv27V3k&t=85s) | 2023-11-27  |  [Matthew Berman](https://www.youtube.com/@matthew_berman)  |
+
+
+##### Chinese tutorials
+| Type        | Deliverable                                            |      Date      |     Author     |
+|-------------|--------------------------------------------------------|----------------|----------------|
+| Blog        | [实测零一万物Yi-VL多模态语言模型：能准确“识图吃瓜”](https://mp.weixin.qq.com/s/fu4O9XvJ03JhimsEyI-SsQ)              |  2024-02-02  |  [苏洋](https://github.com/soulteary)  |
+| Blog        | [本地运行零一万物 34B 大模型，使用 Llama.cpp & 21G 显存](https://zhuanlan.zhihu.com/p/668921042)                  |  2023-11-26  |  [苏洋](https://github.com/soulteary)  |
+| Blog        | [零一万物模型折腾笔记：官方 Yi-34B 模型基础使用](https://zhuanlan.zhihu.com/p/671387298)                           | 2023-12-10 |  [苏洋](https://github.com/soulteary)  |
+| Blog        | [CPU 混合推理，非常见大模型量化方案：“二三五六” 位量化方案](https://zhuanlan.zhihu.com/p/671698216)                  | 2023-12-12 |  [苏洋](https://github.com/soulteary)  |
+| Blog        | [单卡 3 小时训练 Yi-6B 大模型 Agent：基于 Llama Factory 实战](https://zhuanlan.zhihu.com/p/678989191)             | 2024-01-22 | [郑耀威](https://github.com/hiyouga) |
+| Blog        | [零一万物开源Yi-VL多模态大模型，魔搭社区推理&微调最佳实践来啦！](https://zhuanlan.zhihu.com/p/680098411) | 2024-01-26  |  [ModelScope](https://github.com/modelscope)  |
+| Video       | [只需 24G 显存，用 vllm 跑起来 Yi-34B 中英双语大模型](https://www.bilibili.com/video/BV17t4y1f7Ee/)               | 2023-12-28 |  [漆妮妮](https://space.bilibili.com/1262370256)  |
+| Video       | [Yi-VL-34B 多模态大模型 - 用两张 A40 显卡跑起来](https://www.bilibili.com/video/BV1Q5411y7AG/)               | 2023-01-28 |  [漆妮妮](https://space.bilibili.com/1262370256)  |
+
+</details>
+
+
+# Why Yi? 
+
+  - [Ecosystem](#ecosystem)
+    - [Upstream](#upstream)
+    - [Downstream](#downstream)
+      - [Serving](#serving)
+      - [Quantization](#quantization-1)
+      - [Fine-tuning](#fine-tuning-1)
+      - [API](#api)
+  - [Benchmarks](#benchmarks)
+    - [Chat model performance](#chat-model-performance)
+    - [Base model performance](#base-model-performance)
+      - [Yi-34B and Yi-34B-200K](#yi-34b-and-yi-34b-200k)
+      - [Yi-9B](#yi-9b)
+ 
+## Ecosystem
+
+Yi has a comprehensive ecosystem, offering a range of tools, services, and models to enrich your experiences and maximize productivity.
+
+- [Upstream](#upstream)
+- [Downstream](#downstream)
+  - [Serving](#serving)
+  - [Quantization](#quantization-1)
+  - [Fine-tuning](#fine-tuning-1)
+  - [API](#api)
+
+### Upstream
+
+The Yi series models follow the same model architecture as Llama. By choosing Yi, you can leverage existing tools, libraries, and resources within the Llama ecosystem, eliminating the need to create new tools and enhancing development efficiency.
+
+For example, the Yi series models are saved in the format of the Llama model. You can directly use `LlamaForCausalLM` and `LlamaTokenizer` to load the model. For more information, see [Use the chat model](#31-use-the-chat-model).
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained("01-ai/Yi-34b", use_fast=False)
+
+model = AutoModelForCausalLM.from_pretrained("01-ai/Yi-34b", device_map="auto")
+```
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Downstream
+
+> 💡 Tip
+> 
+> - Feel free to create a PR and share the fantastic work you've built using the Yi series models.
+>
+> - To help others quickly understand your work, it is recommended to use the format of `<model-name>: <model-intro> + <model-highlights>`.
+
+#### Serving 
+
+If you want to get up with Yi in a few minutes, you can use the following services built upon Yi.
+
+- Yi-34B-Chat: you can chat with Yi using one of the following platforms:
+  - [Yi-34B-Chat | Hugging Face](https://huggingface.co/spaces/01-ai/Yi-34B-Chat)
+  - [Yi-34B-Chat | Yi Platform](https://platform.lingyiwanwu.com/): **Note** that currently it's available through a whitelist. Welcome to apply (fill out a form in [English](https://cn.mikecrm.com/l91ODJf) or [Chinese](https://cn.mikecrm.com/gnEZjiQ)) and experience it firsthand!
+  
+- [Yi-6B-Chat (Replicate)](https://replicate.com/01-ai): you can use this model with more options by setting additional parameters and calling APIs.
+  
+- [ScaleLLM](https://github.com/vectorch-ai/ScaleLLM#supported-models): you can use this service to run Yi models locally with added flexibility and customization.
+  
+#### Quantization
+
+If you have limited computational capabilities, you can use Yi's quantized models as follows. 
+
+These quantized models have reduced precision but offer increased efficiency, such as faster inference speed and smaller RAM usage.
+
+- [TheBloke/Yi-34B-GPTQ](https://huggingface.co/TheBloke/Yi-34B-GPTQ) 
+- [TheBloke/Yi-34B-GGUF](https://huggingface.co/TheBloke/Yi-34B-GGUF)
+- [TheBloke/Yi-34B-AWQ](https://huggingface.co/TheBloke/Yi-34B-AWQ)
+  
+#### Fine-tuning
+
+If you're seeking to explore the diverse capabilities within Yi's thriving family, you can delve into Yi's fine-tuned models as below.
+
+- [TheBloke Models](https://huggingface.co/TheBloke): this site hosts numerous fine-tuned models derived from various LLMs including Yi. 
+  
+  This is not an exhaustive list for Yi, but to name a few sorted on downloads:
+  - [TheBloke/dolphin-2_2-yi-34b-AWQ](https://huggingface.co/TheBloke/dolphin-2_2-yi-34b-AWQ)
+  - [TheBloke/Yi-34B-Chat-AWQ](https://huggingface.co/TheBloke/Yi-34B-Chat-AWQ)
+  - [TheBloke/Yi-34B-Chat-GPTQ](https://huggingface.co/TheBloke/Yi-34B-Chat-GPTQ)
+  
+- [SUSTech/SUS-Chat-34B](https://huggingface.co/SUSTech/SUS-Chat-34B): this model ranked first among all models below 70B and outperformed the twice larger deepseek-llm-67b-chat. You can check the result on the [Open LLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard).
+  
+- [OrionStarAI/OrionStar-Yi-34B-Chat-Llama](https://huggingface.co/OrionStarAI/OrionStar-Yi-34B-Chat-Llama): this model excelled beyond other models (such as GPT-4, Qwen-14B-Chat, Baichuan2-13B-Chat) in C-Eval and CMMLU evaluations on the [OpenCompass LLM Leaderboard](https://opencompass.org.cn/leaderboard-llm). 
+  
+- [NousResearch/Nous-Capybara-34B](https://huggingface.co/NousResearch/Nous-Capybara-34B): this model is trained with 200K context length and 3 epochs on the Capybara dataset. 
+
+#### API
+
+- [amazing-openai-api](https://github.com/soulteary/amazing-openai-api): this tool converts Yi model APIs into the OpenAI API format out of the box.
+- [LlamaEdge](https://www.secondstate.io/articles/yi-34b/#create-an-openai-compatible-api-service-for-the-yi-34b-chat-model): this tool builds an OpenAI-compatible API server for Yi-34B-Chat using a portable Wasm (WebAssembly) file, powered by Rust.
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+## Benchmarks 
+
+- [Chat model performance](#-chat-model-performance)
+- [Base model performance](#-base-model-performance)
+
+### Chat model performance
+
+Yi-34B-Chat model demonstrates exceptional performance, ranking first among all existing open-source models in the benchmarks including MMLU, CMMLU, BBH, GSM8k, and more.
+
+![Chat model performance](https://github.com/01-ai/Yi/blob/main/assets/img/benchmark_chat.png?raw=true) 
+
+<details>
+<summary> Evaluation methods and challenges. ⬇️ </summary>
+
+- **Evaluation methods**: we evaluated various benchmarks using both zero-shot and few-shot methods, except for TruthfulQA.
+- **Zero-shot vs. few-shot**: in chat models, the zero-shot approach is more commonly employed.
+- **Evaluation strategy**: our evaluation strategy involves generating responses while following instructions explicitly or implicitly (such as using few-shot examples). We then isolate relevant answers from the generated text.
+- **Challenges faced**: some models are not well-suited to produce output in the specific format required by instructions in few datasets, which leads to suboptimal results.
+
+<strong>*</strong>: C-Eval results are evaluated on the validation datasets
+</details>
+
+### Base model performance
+
+#### Yi-34B and Yi-34B-200K 
+
+The Yi-34B and Yi-34B-200K models stand out as the top performers among open-source models, especially excelling in MMLU, CMMLU, common-sense reasoning, reading comprehension, and more.
+
+![Base model performance](https://github.com/01-ai/Yi/blob/main/assets/img/benchmark_base.png?raw=true)
+
+<details>
+<summary> Evaluation methods. ⬇️</summary>
+
+- **Disparity in results**: while benchmarking open-source models, a disparity has been noted between results from our pipeline and those reported by public sources like OpenCompass.
+- **Investigation findings**: a deeper investigation reveals that variations in prompts, post-processing strategies, and sampling techniques across models may lead to significant outcome differences.
+- **Uniform benchmarking process**: our methodology aligns with the original benchmarks—consistent prompts and post-processing strategies are used, and greedy decoding is applied during evaluations without any post-processing for the generated content.
+- **Efforts to retrieve unreported scores**: for scores that were not reported by the original authors (including scores reported with different settings), we try to get results with our pipeline.
+- **Extensive model evaluation**: 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.
+- **Special configurations**: 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".
+- **Falcon-180B caveat**: Falcon-180B was not tested on QuAC and OBQA due to technical constraints. Its performance score is an average from other tasks, and considering the generally lower scores of these two tasks, Falcon-180B's capabilities are likely not underestimated.
+</details>
+
+#### Yi-9B
+
+Yi-9B is almost the best among a range of similar-sized open-source models (including Mistral-7B, SOLAR-10.7B, Gemma-7B, DeepSeek-Coder-7B-Base-v1.5 and more), particularly excelling in code, math, common-sense reasoning, and reading comprehension.
+
+![Yi-9B benchmark - details](https://github.com/01-ai/Yi/blob/main/assets/img/Yi-9B_benchmark_details.png?raw=true)
+
+- In terms of **overall** ability (Mean-All), Yi-9B performs the best among similarly sized open-source models, surpassing DeepSeek-Coder, DeepSeek-Math, Mistral-7B, SOLAR-10.7B, and Gemma-7B.
+
+![Yi-9B benchmark - overall](https://github.com/01-ai/Yi/blob/main/assets/img/Yi-9B_benchmark_overall.png?raw=true)
+
+- In terms of **coding** ability (Mean-Code), Yi-9B's performance is second only to DeepSeek-Coder-7B, surpassing Yi-34B, SOLAR-10.7B, Mistral-7B, and Gemma-7B.
+
+![Yi-9B benchmark - code](https://github.com/01-ai/Yi/blob/main/assets/img/Yi-9B_benchmark_code.png?raw=true)
+
+- In terms of **math** ability (Mean-Math), Yi-9B's performance is second only to DeepSeek-Math-7B, surpassing SOLAR-10.7B, Mistral-7B, and Gemma-7B.
+
+![Yi-9B benchmark - math](https://github.com/01-ai/Yi/blob/main/assets/img/Yi-9B_benchmark_math.png?raw=true)
+
+- In terms of **common sense and reasoning** ability (Mean-Text), Yi-9B's performance is on par with Mistral-7B, SOLAR-10.7B, and Gemma-7B.
+
+![Yi-9B benchmark - text](https://github.com/01-ai/Yi/blob/main/assets/img/Yi-9B_benchmark_text.png?raw=true)
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+# Who can use Yi?
+
+Everyone! 🙌 ✅
+
+- The Yi series models are free for personal usage, academic purposes, and commercial use. All usage must adhere to the [Yi Series Models Community License Agreement 2.1](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt)
+  
+- For free commercial use, you only need to [complete this form](https://www.lingyiwanwu.com/yi-license) to get a Yi Model Commercial License.
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+# Misc.
+
+### Acknowledgments
+
+A heartfelt thank you to each of you who have made contributions to the Yi community! You have helped Yi not just a project, but a vibrant, growing home for innovation.
+
+[![yi contributors](https://contrib.rocks/image?repo=01-ai/yi&max=2000&columns=15)](https://github.com/01-ai/yi/graphs/contributors)
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### Disclaimer
+
+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
+complex 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.
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>
+
+### License
+
+The source code in this repo is licensed under the [Apache 2.0
+license](https://github.com/01-ai/Yi/blob/main/LICENSE). The Yi series models are fully open for academic research and free for commercial use, with automatic permission granted upon application. All usage must adhere to the [Yi Series Models Community License Agreement 2.1](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt).
+For free commercial use, you only need to send an email to [get official commercial permission](https://www.lingyiwanwu.com/yi-license).
+
+<p align="right"> [
+  <a href="#top">Back to top ⬆️ </a>  ] 
+</p>

config.json

@@ -0,0 +1,28 @@
+{
+  "architectures": [
+    "LlamaForCausalLM"
+  ],
+  "attention_bias": false,
+  "attention_dropout": 0.0,
+  "bos_token_id": 1,
+  "eos_token_id": 2,
+  "hidden_act": "silu",
+  "hidden_size": 4096,
+  "initializer_range": 0.02,
+  "intermediate_size": 11008,
+  "max_position_embeddings": 4096,
+  "model_type": "llama",
+  "num_attention_heads": 32,
+  "num_hidden_layers": 48,
+  "num_key_value_heads": 4,
+  "pad_token_id": 0,
+  "pretraining_tp": 1,
+  "rms_norm_eps": 1e-06,
+  "rope_scaling": null,
+  "rope_theta": 10000,
+  "tie_word_embeddings": false,
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.37.2",
+  "use_cache": true,
+  "vocab_size": 64000
+}

generation_config.json

@@ -0,0 +1,7 @@
+{
+  "_from_model_config": true,
+  "bos_token_id": 1,
+  "eos_token_id": 2,
+  "pad_token_id": 0,
+  "transformers_version": "4.37.2"
+}

md5

@@ -0,0 +1,3 @@
+cc6c5cedef9de38564f50ce8d5a1ff95  model-00001-of-00002.safetensors
+b4f9cbad63b082efb8204ec97764ca80  model-00002-of-00002.safetensors
+291724ef50f729e45d68f474a7755bbc  tokenizer.model

output.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3bb4c982ec44f2cee11b86ec1332cee4544d197a1f9cc7ac7022ed6e6ecde944
+size 5200174540

tokenizer.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:386c49cf943d71aa110361135338c50e38beeff0a66593480421f37b319e1a39
+size 1033105

tokenizer_config.json

@@ -0,0 +1,13 @@
+{
+  "add_bos_token": false,
+  "add_eos_token": false,
+  "model_max_length": 4096,
+  "unk_token": "<unk>",
+  "bos_token": "<|startoftext|>",
+  "eos_token": "<|endoftext|>",
+  "pad_token": "<unk>",
+  "sp_model_kwargs": {},
+  "clean_up_tokenization_spaces": false,
+  "legacy": true,
+  "tokenizer_class": "LlamaTokenizer"
+}