Sync README

README.md

@@ -1,64 +1,40 @@
+---
+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 src="https://github.com/01-ai/Yi/raw/main/assets/img/Yi.svg?sanitize=true" width="200px">
-</p>
-<a href="https://github.com/01-ai/Yi/actions/workflows/ci.yml">
-  <img src="https://github.com/01-ai/Yi/actions/workflows/ci.yml/badge.svg">
-</a>
-<a href="https://huggingface.co/01-ai">
-  <img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-01--ai-blue">
-</a>
-<a href="https://www.modelscope.cn/organization/01ai/">
-  <img src="https://img.shields.io/badge/ModelScope-01--ai-blue">
-</a>
-<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>
-<a 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">
-</a>
-<a href="mailto:oss@01.ai">
-  <img src="https://img.shields.io/badge/✉️-yi@01.ai-FFE01B">
-</a>
+
+<img src="./Yi.svg" width="200px">
+
 </div>
 
 ## Introduction
 
 The **Yi** series models are large language models trained from scratch by
-developers at [01.AI](https://01.ai/).
+developers at [01.AI](https://01.ai/). The first public release contains two
+bilingual(English/Chinese) base models with the parameter sizes of 6B([`Yi-6B`](https://huggingface.co/01-ai/Yi-6B)) 
+and 34B([`Yi-34B`](https://huggingface.co/01-ai/Yi-34B)). Both of them are trained 
+with 4K sequence length and can be extended to 32K during inference time. 
+The [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K)
+and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) are base model with
+200K context length.
 
 ## News
 
-<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>
+- 🎯 **2023/11/06**: The base model of [`Yi-6B-200K`](https://huggingface.co/01-ai/Yi-6B-200K) 
+and [`Yi-34B-200K`](https://huggingface.co/01-ai/Yi-34B-200K) with 200K context length.
+- 🎯 **2023/11/02**: The base model of [`Yi-6B`](https://huggingface.co/01-ai/Yi-6B) and 
+[`Yi-34B`](https://huggingface.co/01-ai/Yi-34B).
 
-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 |           -            |           -           |      -      |
@@ -100,169 +76,24 @@ 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
-
-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`
-
-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).
-
-If you prefer to try out with your local development environment. First, create
-a virtual environment and clone this repo. Then install the dependencies with
-`pip install -r requirements.txt`. For the best performance, we recommend you
-also install the latest version (`>=2.3.3`) of
-[flash-attention](https://github.com/Dao-AILab/flash-attention#installation-and-features).
-
-### 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)
+Please visit our [github repository](https://github.com/01-ai/Yi) for general
+guidance on how to use this model.
 
 ## 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.
+Although we use data compliance checking algorithms during the training process
+to ensure the compliance of the trained model to the best of our ability, due to
+the complexity of the data and the diversity of language model usage scenarios,
+we cannot guarantee that the model will generate correct and reasonable output
+in all scenarios. Please be aware that there is still a risk of the model
+producing problematic outputs. We will not be responsible for any risks and
+issues resulting from misuse, misguidance, illegal usage, and related
+misinformation, as well as any associated data security concerns.
 
 ## License
 
-The 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
-([yi@01.ai](mailto:yi@01.ai)).
+The Yi series models are fully open for academic research and free commercial
+usage with permission via applications. All usage must adhere to the [Model
+License Agreement 2.0](https://huggingface.co/01-ai/Yi-6B/blob/main/LICENSE). To
+apply for the official commercial license, please contact us
+([yi@01.ai](mailto:yi@01.ai)).