Update README.md

README.md

@@ -78,3 +78,204 @@ So if you're able and willing to contribute, it'd be most gratefully received an
 * Ko-Fi: https://ko-fi.com/TheBlokeAI
 
 # Original model card: WizardLM 13B 1.0
+
+## WizardLM: An Instruction-following LLM Using Evol-Instruct
+Empowering Large Pre-Trained Language Models to Follow Complex Instructions
+
+<p align="center" width="100%">
+<a ><img src="imgs/WizardLM.png" alt="WizardLM" style="width: 20%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+[![Code License](https://img.shields.io/badge/Code%20License-Apache_2.0-green.svg)](https://github.com/tatsu-lab/stanford_alpaca/blob/main/LICENSE)
+[![Data License](https://img.shields.io/badge/Data%20License-CC%20By%20NC%204.0-red.svg)](https://github.com/tatsu-lab/stanford_alpaca/blob/main/DATA_LICENSE)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/release/python-390/)
+
+## News
+
+At present, our core contributors are preparing the **33B** version and we expect to empower WizardLM with the ability to perform instruction evolution itself, aiming to evolve your specific data at a low cost.
+
+- 🔥 We released **13B** version of **WizardLM** trained with **250k** evolved instructions (from ShareGPT). Checkout the [Demo_13B](https://a6d4f31b5a1ee33f.gradio.app/), [Demo_13B_bak](https://e79c80d2c2379e77.gradio.app) and the GPT-4 evaluation. Please download our delta model at the following [link](https://huggingface.co/victor123/WizardLM-13B-1.0).
+- 🔥 We released **7B** version of **WizardLM** trained with **70k** evolved instructions (from Alpaca data). Checkout the [paper](https://arxiv.org/abs/2304.12244) and [Demo_7B](https://f195ccdce69a86d5.gradio.app) , [Demo_7B_bak](https://ce25bd0feced0f77.gradio.app)
+- &#x1F4E3; We are looking for highly motivated students to join us as interns to create more intelligent AI together. Please contact caxu@microsoft.com
+
+<!-- Although on our **complexity-balanced test set**, **WizardLM-7B has more cases that are preferred by human labelers than ChatGPT** in the high-complexity instructions (difficulty level >= 8), it still lags behind ChatGPT on the entire test set, and we also consider WizardLM to still be in a **baby state**. This repository will **continue to improve WizardLM**, train on larger scales, add more training data, and innovate more advanced large-model training methods. -->
+
+<b>Note for 13B model usage:</b> To obtain results **identical to our demo**, please strictly follow the prompts and invocation methods provided in the **"src/infer_wizardlm13b.py"** to use our 13B model for inference. Unlike the 7B model, the 13B model adopts the prompt format from Vicuna and supports **multi-turn** conversation.
+
+<b>Note for demo usage:</b> We only recommend using **English** to experience our model. Support for other languages will be introduced in the future. The demo currently only supports **single-turn** conversation.
+
+### GPT-4 automatic evaluation
+
+We adopt the automatic evaluation framework based on GPT-4 proposed by FastChat to assess the performance of chatbot models. As shown in the following figure, WizardLM-13B achieved better results than Vicuna-13b.
+<p align="center" width="100%">
+<a ><img src="imgs/WizarLM13b-GPT4.png" alt="WizardLM" style="width: 100%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+### WizardLM-13B performance on different skills.
+
+The following figure compares WizardLM-13B and ChatGPT’s skill on Evol-Instruct testset. The result indicates that WizardLM-13B achieves 89.1% of ChatGPT’s performance on average, with almost 100% (or more than) capacity on 10 skills, and more than 90% capacity on 22 skills.
+
+<p align="center" width="100%">
+<a ><img src="imgs/evol-testset_skills-13b.png" alt="WizardLM" style="width: 100%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+## Call for Feedbacks
+We welcome everyone to use your professional and difficult instructions to evaluate WizardLM, and show us examples of poor performance and your suggestions in the [issue discussion](https://github.com/nlpxucan/WizardLM/issues) area. We are focusing on improving the Evol-Instruct now and hope to relieve existing weaknesses and issues in the the next version of WizardLM. After that, we will open the code and pipeline of up-to-date Evol-Instruct algorithm and work with you together to improve it.
+
+## Unofficial Video Introductions
+Thanks to the enthusiastic friends, their video introductions are more lively and interesting.
+1. [GET WizardLM NOW! 7B LLM KING That Can Beat ChatGPT! I'm IMPRESSED!](https://www.youtube.com/watch?v=SaJ8wyKMBds)
+2. [WizardLM: Enhancing Large Language Models to Follow Complex Instructions](https://www.youtube.com/watch?v=I6sER-qivYk)
+
+## Case Show
+We just sample some cases to demonstrate the performance of WizardLM and ChatGPT on data of varying difficulty, and the details pls refer [Case Show](https://github.com/nlpxucan/WizardLM/blob/main/src/case_show.md).
+
+## Overview of Evol-Instruct
+
+[Evol-Instruct](https://github.com/nlpxucan/evol-instruct) is a novel method using LLMs instead of humans to automatically mass-produce open-domain instructions of various difficulty levels and skills range, to improve the performance of LLMs.
+
+<p align="center" width="100%">
+<a ><img src="imgs/git_overall.png" alt="WizardLM" style="width: 86%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+<p align="center" width="100%">
+<a ><img src="imgs/git_running.png" alt="WizardLM" style="width: 86%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+## Contents
+
+1. [Online Demo](#online-demo)
+
+2. [Training Data](#training-data)
+
+3. [WizardLM Weights](#wizardlm-weights)
+
+4. [Fine-tuning](#fine-tuning)
+
+5. [Distributed Fine-tuning](#distributed-Fine-tuning)
+
+6. [Inference](#inference)
+
+7. [Evaluation](#evaluation)
+
+8. [Citation](#citation)
+
+9. [Disclaimer](#disclaimer)
+
+## Online Demo
+
+We will provide our latest models for you to try for as long as possible. If you find a link is not working, please try another one. At the same time, please try as many **real-world** and **challenging** problems that you encounter in your work and life as possible. We will continue to evolve our models with your feedbacks.
+
+[Demo Link](https://011fc8477ad734d7.gradio.app)
+
+[Demo Backup 1](https://1825e531c43a23c7.gradio.app)
+
+
+
+
+## Training Data
+
+[`alpaca_evol_instruct_70k.json`](https://huggingface.co/datasets/victor123/evol_instruct_70k) contains 70K instruction-following data generated from Evol-Instruct. We used it for fine-tuning the WizardLM model.
+This JSON file is a list of dictionaries, each dictionary contains the following fields:
+
+- `instruction`: `str`, describes the task the model should perform. Each of the 70K instructions is unique.
+- `output`: `str`, the answer to the instruction as generated by `gpt-3.5-turbo`.
+
+
+
+## WizardLM Weights
+We release [WizardLM] weights as delta weights to comply with the LLaMA model license.
+You can add our delta to the original LLaMA weights to obtain the WizardLM weights. Instructions:
+1. Get the original LLaMA weights in the huggingface format by following the instructions [here](https://huggingface.co/docs/transformers/main/model_doc/llama).
+2. Please download our delta model at the following [link](https://huggingface.co/victor123/WizardLM)
+3. Use the following scripts to get WizardLM weights by applying our delta:
+```
+python src/weight_diff_wizard.py recover --path_raw <path_to_step_1_dir> --path_diff <path_to_step_2_dir> --path_tuned <path_to_store_recovered_weights>
+```
+
+## Fine-tuning
+
+We fine-tune WizardLM using code from [Llama-X](https://github.com/AetherCortex/Llama-X).
+We fine-tune LLaMA-7B and LLaMA-13B with the following hyperparameters:
+
+| Hyperparameter | LLaMA-7B | LLaMA-13B|
+|----------------|----------|----------|
+| Batch size     | 64       | 384      |
+| Learning rate  | 2e-5     | 2e-5     |
+| Epochs         | 3        | 3        |
+| Max length     | 2048     | 2048     |
+| Warmup step    | 2        | 50       |
+| LR scheduler   | cosine   | cosine   |
+
+To reproduce our fine-tuning of WizardLM, please follow the following steps:
+1. According to the instructions of [Llama-X](https://github.com/AetherCortex/Llama-X), install the environment, download the training code, and deploy.
+2. Replace the train.py with the train_freeform.py in our repo(src/train_freeform.py)
+3. Execute the following training command:
+```bash
+deepspeed train_freeform.py \
+    --model_name_or_path /path/to/llama-7B/hf \
+    --data_path /path/to/alpaca_evol_instruct_70k.json \
+    --output_dir /path/to/wizardlm-7B/hf/ft \
+    --num_train_epochs 3 \
+    --model_max_length 2048 \
+    --per_device_train_batch_size 8 \
+    --per_device_eval_batch_size 1 \
+    --gradient_accumulation_steps 1 \
+    --evaluation_strategy "no" \
+    --save_strategy "steps" \
+    --save_steps 800 \
+    --save_total_limit 3 \
+    --learning_rate 2e-5 \
+    --warmup_steps 2 \
+    --logging_steps 2 \
+    --lr_scheduler_type "cosine" \
+    --report_to "tensorboard" \
+    --gradient_checkpointing True \
+    --deepspeed configs/deepspeed_config.json \
+    --fp16 True
+```
+
+## Distributed Fine-tuning
+See [Distributed Fine-tuning](./doc/distributed_finetune.md)
+
+## Inference
+
+We provide the decoding script for WizardLM, which reads a input file and generates corresponding responses for each sample, and finally consolidates them into an output file.
+
+You can specify `base_model`, `input_data_path` and `output_data_path` in src\inference_wizardlm.py to set the decoding model, path of input file and path of output file.
+The decoding command:
+```
+python src\inference_wizardlm.py
+```
+
+### Evaluation
+
+To evaluate Wizard, we conduct human evaluation on the inputs from our human instruct evaluation set [`WizardLM_testset.jsonl`](./data/WizardLM_testset.jsonl) . This evaluation set was collected by the authors and covers a diverse list of user-oriented instructions including difficult Coding Generation & Debugging, Math, Reasoning, Complex Formats, Academic Writing, Extensive Disciplines, and so on. We performed a blind pairwise comparison between Wizard and baselines. Specifically, we recruit 10 well-educated annotators to rank the models from 1 to 5 on relevance, knowledgeable, reasoning, calculation and accuracy.
+
+WizardLM achieved significantly better results than Alpaca and Vicuna-7b.
+<p align="center" width="60%">
+<a ><img src="imgs/win.png" alt="WizardLM" style="width: 60%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+In the high-difficulty section of our test set (difficulty level >= 8), WizardLM even outperforms ChatGPT, with a win rate 7.9% larger than Chatgpt (42.9% vs. 35.0%). This indicates that our method can significantly improve the ability of large language models to handle complex instructions.
+<p align="center" width="60%">
+<a ><img src="imgs/windiff.png" alt="WizardLM" style="width: 60%; min-width: 300px; display: block; margin: auto;"></a>
+</p>
+
+### Citation
+
+Please cite the repo if you use the data or code in this repo.
+
+```
+@misc{xu2023wizardlm,
+      title={WizardLM: Empowering Large Language Models to Follow Complex Instructions},
+      author={Can Xu and Qingfeng Sun and Kai Zheng and Xiubo Geng and Pu Zhao and Jiazhan Feng and Chongyang Tao and Daxin Jiang},
+      year={2023},
+      eprint={2304.12244},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+## Disclaimer
+
+The resources, including code, data, and model weights, associated with this project are restricted for academic research purposes only and cannot be used for commercial purposes. The content produced by any version of WizardLM is influenced by uncontrollable variables such as randomness, and therefore, the accuracy of the output cannot be guaranteed by this project. This project does not accept any legal liability for the content of the model output, nor does it assume responsibility for any losses incurred due to the use of associated resources and output results.