Auto Sync from git://github.com/01-ai/Yi.git/commit/be36b86d8d624bbebcb7bfc76bc9221b375fb40a

LICENSE

@@ -0,0 +1,323 @@
+                    Yi Series Models License Agreement
+                            Version: 2.0
+                    Date of Release: November 4, 2023
+ 
+1. Definition
+
+“Agreement” refers to the terms and conditions defined in this Yi Series Models
+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,
+you should contact the Licensor in advance as specified in Section 7 of this
+Agreement named "Updates to the Agreement and Contact Information" and obtain
+written authorization from the Licensor. When you obtain authorization from the
+Licensor to use the Yi Series Models and Derivatives for Commercial Purposes,
+you must comply with the afore-mentioned license restrictions.
+ 
+ 
+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 [email protected].
+
+
+                      Yi系列模型许可协议
+                        版本: 2.0
+                    发布日期: 2023年11月4日 
+ 
+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系列模型及模型衍生品用作商业用途，您应当事先通过第7款“协议更新及
+联系方式”中的方式联系许可方进行登记并获得许可方的书面授权。若您取得许可方授权将
+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公布协议最新版本。有关许
+可和版权的任何问题，请通过[email protected] 与许可方联系。

README.md

@@ -2,4 +2,330 @@
 license: other
 license_name: yi-license
 license_link: LICENSE
+widget:
+  - 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">
+
+<p align="center">
+<img width="200px" src="https://github.com/01-ai/Yi/raw/main/assets/img/Yi.svg?sanitize=true">
+</p>
+
+<div style="display: inline-block;">
+<a rel="noopener nofollow" 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" style="margin: 0 0;">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a href="https://huggingface.co/01-ai">
+  <img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-01--ai-blue" style="margin: 0 0;">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a rel="noopener nofollow" href="https://www.modelscope.cn/organization/01ai/">
+  <img src="https://img.shields.io/badge/ModelScope-01--ai-blue" style="margin: 0 0;">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a rel="noopener nofollow" href="https://github.com/01-ai/Yi/blob/main/LICENSE">
+  <img src="https://img.shields.io/badge/Code_License-Apache_2.0-lightblue" style="margin: 0 0;">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a rel="noopener nofollow" href="https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt">
+  <img src="https://img.shields.io/badge/Model_License-Model_Agreement-lightblue" style="margin: 0 0;">
+</a>
+</div>
+
+<div style="display: inline-block;">
+<a rel="noopener nofollow" href="mailto:[email protected]">
+  <img src="https://img.shields.io/badge/✉️[email protected]" style="margin: 0 0;">
+</a>
+</div>
+
+</div>
+
+## Introduction
+
+The **Yi** series models are large language models trained from scratch by
+developers at [01.AI](https://01.ai/).
+
+## News
+
+<details open>
+<summary>🔔 <b>2023/11/15</b>: The commercial licensing agreement for the Yi series models <a href="https://huggingface.co/01-ai/Yi-34B/discussions/28#65546af9198da1df586baaf2">is set to be updated</a>.</summary>
+</details>
+
+<details open>
+<summary>🔥 <b>2023/11/08</b>: Invited test of Yi-34B chat model.</summary>
+
+Application form:
+
+- [English](https://cn.mikecrm.com/l91ODJf)
+- [Chinese](https://cn.mikecrm.com/gnEZjiQ)
+
+</details>
+
+<details>
+<summary>🎯 <b>2023/11/05</b>: The base model of <code>Yi-6B-200K</code> and <code>Yi-34B-200K</code>.</summary>
+
+This release contains two base models with the same parameter sizes of previous
+release, except that the context window is extended to 200K.
+
+</details>
+
+<details>
+<summary>🎯 <b>2023/11/02</b>: The base model of <code>Yi-6B</code> and <code>Yi-34B</code>.</summary>
+
+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>
+
+## 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
+
+Feel free to [create an issue](https://github.com/01-ai/Yi/issues/new) if you
+encounter any problem when using the **Yi** series models.
+
+### 1. Prepare development environment
+
+#### 1.1 Docker
+The best approach to try the **Yi** series models is through Docker with GPUs. We
+provide the following docker images to help you get started.
+
+- `registry.lingyiwanwu.com/ci/01-ai/yi:latest`
+- `ghcr.io/01-ai/yi:latest`
+
+Note that the `latest` tag always points to the latest code in the `main`
+branch. To test a stable version, please replace it with a specific
+[tag](https://github.com/01-ai/Yi/tags).
+
+#### 1.2 Local development environment
+We use [`conda-lock`](https://github.com/conda/conda-lock) to generate fully reproducible lock files for conda environments. You can refer to [conda-lock.yml](./conda-lock.yml) for the exact versions of the dependencies. Additionally, we utilize [`micromamba`](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) for installing these dependencies.
+
+To install the dependencies, please follow these steps:
+1. Install `micromamba` by following the instructions available [here](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html).
+2. Execute `micromamba install -y -n yi -f conda-lock.yml` to create a conda environment named `yi` and install the necessary dependencies.
+
+### 2. Download the model (optional)
+
+By default, the model weights and tokenizer will be downloaded from
+[HuggingFace](https://huggingface.co/01-ai) automatically in the next step. You
+can also download them manually from the following places:
+
+- [ModelScope](https://www.modelscope.cn/organization/01ai/)
+- [WiseModel](https://wisemodel.cn/models) (Search for `Yi`)
+- Mirror site (remember to extract the content with `tar`)
+  - [Yi-6B.tar](https://storage.lingyiwanwu.com/yi/models/Yi-6B.tar)
+  - [Yi-6B-200K.tar](https://storage.lingyiwanwu.com/yi/models/Yi-6B-200K.tar)
+  - [Yi-34B.tar](https://storage.lingyiwanwu.com/yi/models/Yi-34B.tar)
+  - [Yi-34B-200K.tar](https://storage.lingyiwanwu.com/yi/models/Yi-34B-200K.tar)
+
+### 3. Examples
+
+#### 3.1 Use the base model
+
+```bash
+python demo/text_generation.py
+```
+
+To reuse the downloaded models in the previous step, you can provide the extra
+`--model` argument:
+
+```bash
+python demo/text_generation.py  --model /path/to/model
+```
+
+Or if you'd like to get your hands dirty:
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model = AutoModelForCausalLM.from_pretrained("01-ai/Yi-34B", device_map="auto", torch_dtype="auto", trust_remote_code=True)
+tokenizer = AutoTokenizer.from_pretrained("01-ai/Yi-34B", trust_remote_code=True)
+inputs = tokenizer("There's a place where time stands still. A place of breath taking wonder, but also", return_tensors="pt")
+max_length = 256
+
+outputs = model.generate(
+    inputs.input_ids.cuda(),
+    max_length=max_length,
+    eos_token_id=tokenizer.eos_token_id,
+    do_sample=True,
+    repetition_penalty=1.3,
+    no_repeat_ngram_size=5,
+    temperature=0.7,
+    top_k=40,
+    top_p=0.8,
+)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+<details>
+
+<summary>Output</summary>
+
+**Prompt**: There's a place where time stands still. A place of breath taking wonder, but also
+
+**Generation**: There's a place where time stands still. A place of breath taking wonder, but also of great danger. A place where the very air you breathe could kill you. A place where the only way to survive is to be prepared.
+The place is called the Arctic.
+The Arctic is a vast, frozen wilderness. It is a place of extremes. The temperatures can drop to -40 degrees Celsius. The winds can reach speeds of 100 kilometers per hour. The sun can shine for 24 hours a day, or not at all for weeks on end.
+The Arctic is also a place of great beauty. The ice and snow are a pristine white. The sky is a deep blue. The sunsets are spectacular.
+But the Arctic is also a place of great danger. The ice can be treacherous. The winds can be deadly. The sun can be blinding.
+The Arctic is a place where the only way to survive is to be prepared.
+The Arctic is a place of extremes. The temperatures can drop to -40 degrees Celsius. The winds can reach speeds of 100 kilometers per hour. The sun can shine for 24 hours a day, or not at all for weeks on end.
+The Arctic is a place of great beauty. The ice and snow are a
+
+</details>
+
+For more advanced usage, please refer to the
+[doc](https://github.com/01-ai/Yi/tree/main/demo).
+
+#### 3.2 Finetuning from the base model:
+
+```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
+```
+
+For more advanced usage like fine-tuning based on your custom data, please refer
+the [doc](https://github.com/01-ai/Yi/tree/main/finetune).
+
+#### 3.3 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
+```
+
+For a more detailed explanation, please read the [doc](https://github.com/01-ai/Yi/tree/main/quantization/gptq)
+
+##### 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 resulted model as follows:
+
+```bash
+python quantization/awq/eval_quantized_model.py \
+  --model /quantized_model                       \
+  --trust_remote_code
+```
+
+For more detailed explanation, please read the [doc](https://github.com/01-ai/Yi/tree/main/quantization/awq)
+
+## Ecosystem
+
+🤗 You are encouraged to create a PR and share your awesome work built on top of
+the Yi series models.
+
+- Serving
+  - [ScaleLLM](https://github.com/vectorch-ai/ScaleLLM#supported-models): Efficiently run Yi models locally.
+- Quantization
+  - [TheBloke/Yi-34B-GGUF](https://huggingface.co/TheBloke/Yi-34B-GGUF)
+  - [TheBloke/Yi-34B-GPTQ](https://huggingface.co/TheBloke/Yi-34B-GPTQ)
+- Finetuning
+  - [NousResearch/Nous-Capybara-34B](https://huggingface.co/NousResearch/Nous-Capybara-34B)
+
+## FAQ
+
+1. **Will you release the chat version?**
+
+    Yes, the chat version will be released around the end of November 2023.
+
+1. **What dataset was this trained with?**
+
+    The dataset we use contains Chinese & English only. We used approximately 3T
+    tokens. The detailed number and its construction will be described in the
+    upcoming technical report.
+
+## 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.
+
+## 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 commercial usage with permission
+via applications. All usage must adhere to the [Model License
+Agreement 2.0](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt).
+To apply for the official commercial license, please contact us
+([[email protected]](mailto:[email protected])).