Update README.md

README.md

@@ -1,4 +1,16 @@
 ---
+pipeline_tag: text-generation
+inference: true
+widget:
+- text: 'def print_hello_world():'
+  example_title: Hello world
+  group: Python
+datasets:
+- bigcode/commitpackft
+- bigcode/oasst-octopack
+metrics:
+- code_eval
+library_name: transformers
 language:
 - zh
 - en
@@ -6,97 +18,326 @@ tags:
 - codegeex
 - glm
 - chatglm
-- thudm
+model-index:
+- name: OctoGeeX
+  results:
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize Python
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 46.2
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize JavaScript
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 39.2
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize Java
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 38.2
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize Go
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 30.4
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize C++
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 35.6
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize Rust
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 23.4
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalSynthesize Average
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 35.5
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix Python
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 30.2
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix JavaScript
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 28.4
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix Java
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 30.6
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix Go
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 30.2
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix C++
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 26.1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix Rust
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 16.5
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalFix Average
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 27.0
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain Python
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 35.1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain JavaScript
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 24.5
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain Java
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 27.3
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain Go
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 21.1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain C++
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 24.1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain Rust
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 14.8
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      type: bigcode/humanevalpack
+      name: HumanEvalExplain Average
+    metrics:
+    - name: pass@1
+      type: pass@1
+      value: 24.5
+      verified: false
 ---
 
-![](resources/codegeex_logo.png)
+![Octopack](https://github.com/bigcode-project/octopack/blob/31f3320f098703c7910e43492c39366eeea68d83/banner.png?raw=true)
 
-<p align="center">
-    🏠 <a href="https://codegeex.cn" target="_blank">Homepage</a>｜💻 <a href="https://github.com/THUDM/CodeGeeX2" target="_blank">GitHub</a>｜🛠 Tools <a href="https://marketplace.visualstudio.com/items?itemName=aminer.codegeex" target="_blank">VS Code</a>, <a href="https://plugins.jetbrains.com/plugin/20587-codegeex" target="_blank">Jetbrains</a>｜🤗 <a href="https://huggingface.co/THUDM/codegeex2-6b" target="_blank">HF Repo</a>｜📄 <a href="https://arxiv.org/abs/2303.17568" target="_blank">Paper</a>
-</p>
+# OctoGeeX
 
-<p align="center">
-    👋 Join our <a href="https://discord.gg/8gjHdkmAN6" target="_blank">Discord</a>, <a href="https://join.slack.com/t/codegeexworkspace/shared_invite/zt-1s118ffrp-mpKKhQD0tKBmzNZVCyEZLw" target="_blank">Slack</a>, <a href="https://t.me/+IipIayJ32B1jOTg1" target="_blank">Telegram</a>, <a href="https://github.com/THUDM/CodeGeeX2/blob/main/resources/wechat.md"target="_blank">WeChat</a>
-</p>
+Play with the model on the [TODO Playground](https://huggingface.co/spaces/bigcode/bigcode-playground).
 
-INT4量化版本｜INT4 quantized version [codegeex2-6b-int4](https://huggingface.co/THUDM/codegeex2-6b-int4)
+##  Table of Contents
 
-# CodeGeeX2: 更强大的多语言代码生成模型
-# A More Powerful Multilingual Code Generation Model
+1. [Model Summary](##model-summary)
+2. [Use](##use)
+3. [Limitations](##limitations)
+4. [Training](##training)
+5. [License](##license)
+6. [Citation](##citation)
 
-CodeGeeX2 是多语言代码生成模型 [CodeGeeX](https://github.com/THUDM/CodeGeeX) ([KDD’23](https://arxiv.org/abs/2303.17568)) 的第二代模型。CodeGeeX2 基于 [ChatGLM2](https://github.com/THUDM/ChatGLM2-6B) 架构加入代码预训练实现，得益于 ChatGLM2 的更优性能，CodeGeeX2 在多项指标上取得性能提升（+107% > CodeGeeX；仅60亿参数即超过150亿参数的 StarCoder-15B 近10%），更多特性包括：
+## Model Summary
 
-* **更强大的代码能力**：基于 ChatGLM2-6B 基座语言模型，CodeGeeX2-6B 进一步经过了 600B 代码数据预训练，相比一代模型，在代码能力上全面提升，[HumanEval-X](https://huggingface.co/datasets/THUDM/humaneval-x) 评测集的六种编程语言均大幅提升 (Python +57%, C++ +71%, Java +54%, JavaScript +83%, Go +56%, Rust +321\%)，在Python上达到 35.9\% 的 Pass@1 一次通过率，超越规模更大的 StarCoder-15B。
-* **更优秀的模型特性**：继承 ChatGLM2-6B 模型特性，CodeGeeX2-6B 更好支持中英文输入，支持最大 8192 序列长度，推理速度较一代 CodeGeeX-13B 大幅提升，量化后仅需6GB显存即可运行，支持轻量级本地化部署。
-* **更全面的AI编程助手**：CodeGeeX插件（[VS Code](https://marketplace.visualstudio.com/items?itemName=aminer.codegeex), [Jetbrains](https://plugins.jetbrains.com/plugin/20587-codegeex)）后端升级，支持超过100种编程语言，新增上下文补全、跨文件补全等实用功能。结合 Ask CodeGeeX 交互式AI编程助手，支持中英文对话解决各种编程问题，包括且不限于代码解释、代码翻译、代码纠错、文档生成等，帮助程序员更高效开发。
-* **更开放的协议**：CodeGeeX2-6B 权重对学术研究完全开放，填写[登记表](https://open.bigmodel.cn/mla/form?mcode=CodeGeeX2-6B)申请商业使用。
+OctoGeeX is an instruction tuned model with 6B parameters created by fine-tuning [CodeGeeX2](https://huggingface.co/THUDM/codegeex2-6b) on [CommitPackFT](https://huggingface.co/datasets/bigcode/commitpackft) & [OASST](https://huggingface.co/datasets/bigcode/oasst-octopack) as described in the OctoPack paper.
 
+- **Repository:** [bigcode/octopack](https://github.com/bigcode-project/octopack)
+- **Paper:** [TODO]()
+- **Languages:** 80+ Programming languages
+- **OctoPack🐙🎒:**
+<table>
+<tr>
+<th>Data</t> 
+<th><a href=https://huggingface.co/datasets/bigcode/commitpack>CommitPack</a></th>
+<td>4TB of GitHub commits across 350 programming languages</td>
+</tr>
+<tr>
+<th></t> 
+<th><a href=https://huggingface.co/datasets/bigcode/commitpackft>CommitPackFT</a></th>
+<td>Filtered version of CommitPack for high-quality commit messages that resemble instructions</td>
+</tr>
+<tr>
+<th>Model</t> 
+<th><a href=https://huggingface.co/bigcode/octocoder>OctoCoder</a></th>
+<td>StarCoder (16B parameters) instruction tuned on CommitPackFT + OASST</td>
+</tr>
+<tr>
+<th></t> 
+<th><a href=https://huggingface.co/bigcode/octogeex>OctoGeeX</a></th>
+<td>CodeGeeX2 (6B parameters) instruction tuned on CommitPackFT + OASST</td>
+</tr>
+<tr>
+<th>Evaluation&nbsp;&nbsp;</t> 
+<th><a href=https://huggingface.co/datasets/bigcode/humanevalpack>HumanEvalPack</a></th>
+<td>Extension of OpenAI's HumanEval to cover 3 scenarios across 6 languages</td>
+</tr>
+</table>
 
-CodeGeeX2 is the second-generation model of the multilingual code generation model [CodeGeeX](https://github.com/THUDM/CodeGeeX) ([KDD’23](https://arxiv.org/abs/2303.17568)), which is implemented based on the [ChatGLM2](https://github.com/THUDM/ChatGLM2-6B) architecture trained on more code data. Due to the advantage of ChatGLM2, CodeGeeX2 has been comprehensively improved in coding capability (+107% > CodeGeeX; with only 6B parameters, surpassing larger StarCoder-15B for some tasks). It has the following features:
 
-* **More Powerful Coding Capabilities**: Based on the ChatGLM2-6B model, CodeGeeX2-6B has been further pre-trained on 600B code tokens, which has been comprehensively improved in coding capability compared to the first-generation. On the [HumanEval-X](https://huggingface.co/datasets/THUDM/humaneval-x) benchmark, all six languages have been significantly improved (Python +57%, C++ +71%, Java +54%, JavaScript +83%, Go +56%, Rust +321\%), and in Python it reached 35.9% of Pass@1 one-time pass rate, surpassing the larger StarCoder-15B.
-* **More Useful Features**: Inheriting the ChatGLM2-6B model features, CodeGeeX2-6B better supports both Chinese and English prompts, maximum 8192 sequence length, and the inference speed is significantly improved compared to the first-generation. After quantization, it only needs 6GB of GPU memory for inference, thus supports lightweight local deployment.
-* **Comprehensive AI Coding Assistant**: The backend of CodeGeeX plugin ([VS Code](https://marketplace.visualstudio.com/items?itemName=aminer.codegeex), [Jetbrains](https://plugins.jetbrains.com/plugin/20587-codegeex)) is upgraded, supporting 100+ programming languages, and adding practical functions such as infilling and cross-file completion. Combined with the "Ask CodeGeeX" interactive AI coding assistant, it can be used to solve various programming problems via Chinese or English dialogue, including but not limited to code summarization, code translation, debugging, and comment generation, which helps increasing the efficiency of developpers.
-* **Open Liscense**: CodeGeeX2-6B weights are fully open to academic research, and please apply for commercial use by filling in the [registration form](https://open.bigmodel.cn/mla/form?mcode=CodeGeeX2-6B).
+## Use
 
+### Intended use
 
-## 软件依赖 ｜ Dependency
+The model follows instructions provided in the input. We recommend prefacing your input with "Question: " and finishing with "Answer:", for example: "Question: Please write a function in Python that performs bubble sort.\n\nAnswer:"
 
-```shell
-pip install protobuf transformers==4.30.2 cpm_kernels torch>=2.0 gradio mdtex2html sentencepiece accelerate
-```
-
-## 快速开始 ｜ Get Started
+**Feel free to share your generations in the Community tab!**
 
+### Generation
 ```python
-from transformers import AutoTokenizer, AutoModel
-tokenizer = AutoTokenizer.from_pretrained("THUDM/codegeex2-6b", trust_remote_code=True)
-model = AutoModel.from_pretrained("THUDM/codegeex2-6b", trust_remote_code=True, device='cuda')
-model = model.eval()
+# pip install -q transformers
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-# remember adding a language tag for better performance
-prompt = "# language: python\n# write a bubble sort function\n"
-inputs = tokenizer.encode(prompt, return_tensors="pt").to(model.device)
-outputs = model.generate(inputs, max_length=256, top_k=1)
-response = tokenizer.decode(outputs[0])
+checkpoint = "bigcode/octogeex"
+device = "cuda" # for GPU usage or "cpu" for CPU usage
 
->>> print(response)
-# language: python
-# write a bubble sort function
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+model = AutoModelForCausalLM.from_pretrained(checkpoint).to(device)
 
+inputs = tokenizer.encode("Question: Please write a function in Python that performs bubble sort.\n\nAnswer:", return_tensors="pt").to(device)
+outputs = model.generate(inputs)
+print(tokenizer.decode(outputs[0]))
+```
 
-def bubble_sort(list):
-    for i in range(len(list) - 1):
-        for j in range(len(list) - 1):
-            if list[j] > list[j + 1]:
-                list[j], list[j + 1] = list[j + 1], list[j]
-    return list
+# Training
 
+## Model
 
-print(bubble_sort([5, 2, 4, 6, 1, 3]))
-```
+- **Architecture:** GPT-2 model with multi-query attention and Fill-in-the-Middle objective
+- **Steps:** 250k pretraining & 30 instruction tuning
+- **Pretraining tokens:** 1 trillion pretraining & 2M instruction tuning
+- **Precision:** bfloat16
 
-关于更多的使用说明，请参考 CodeGeeX2 的 [Github Repo](https://github.com/THUDM/CodeGeeX2)。
+## Hardware
 
-For more information, please refer to CodeGeeX2's [Github Repo](https://github.com/THUDM/CodeGeeX2).
+- **Pretraining:**
+  - **GPUs:** 512 Tesla A100
+  - **Training time:** 24 days
+- **Instruction tuning:**
+  - **GPUs:** 8 Tesla A100
+  - **Training time:** 4 hours
 
-## 协议 ｜ License
+## Software
 
-本仓库的代码依照 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 协议开源，模型的权重的使用则需要遵循 [Model License](MODEL_LICENSE)。
+- **Orchestration:** [Megatron-LM/Transformers](https://github.com/bigcode-project/octopack#training)
+- **Neural networks:** [PyTorch](https://github.com/pytorch/pytorch)
 
-The code in this repository is open source under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) license. The model weights are licensed under the [Model License](MODEL_LICENSE).
+## 协议 ｜ License
 
-## 引用 ｜ Citation
+本仓库的代码依照 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 协议开源，模型的权重的使用则需要遵循 [Model License](MODEL_LICENSE)。
 
-如果觉得我们的工作有帮助，欢迎引用以下论文：
+The code in this repository is open-source under the [MIT license](https://github.com/bigcode-project/octopack/blob/main/LICENSE). The model weights are licensed under the [Model License](MODEL_LICENSE).
 
-If you find our work helpful, please feel free to cite the following paper:
+# Citation
 
-```
-@inproceedings{zheng2023codegeex,
-      title={CodeGeeX: A Pre-Trained Model for Code Generation with Multilingual Evaluations on HumanEval-X}, 
-      author={Qinkai Zheng and Xiao Xia and Xu Zou and Yuxiao Dong and Shan Wang and Yufei Xue and Zihan Wang and Lei Shen and Andi Wang and Yang Li and Teng Su and Zhilin Yang and Jie Tang},
-      booktitle={KDD},
-      year={2023}
-}
-```
+TODO