Create README.md

README.md

@@ -0,0 +1,247 @@
+---
+license: bigcode-openrail-m
+datasets:
+- bigcode/starcoderdata
+- bigcode/the-stack-dedup
+metrics:
+- code_eval
+library_name: transformers
+pipeline_tag: text-generation
+tags:
+- code
+---
+
+# **Opencsg-starcoder2-15b-v0.1**          [[中文]](#chinese)    [[English]](#english)
+
+<a id="english"></a>
+
+<p align="center">
+<img width="300px" alt="OpenCSG" src="https://cdn-uploads.huggingface.co/production/uploads/64c71b27d43e4dee51a8b31a/GwYXPKuEoGCGcMICeW-sb.jpeg">
+</p>
+
+<p align="center"><a href="https://portal.opencsg.com/models">[OpenCSG Community]</a>   <a href="https://github.com/opencsgs">[github]</a>  <a href="https://cdn-uploads.huggingface.co/production/uploads/64c71b27d43e4dee51a8b31a/HU6vz21qKTEmUBCWqCFh9.jpeg">[wechat]</a>  <a href="https://twitter.com/OpenCsg">[Twitter]</a> </p>
+
+
+</div>
+OpenCSG stands for Converged resources, Software refinement, and Generative LM. The 'C' represents Converged resources, indicating the integration and full utilization of hybrid resources. The 'S' stands for Software refinement, signifying software that is refined by large models. The 'G' represents Generative LM, which denotes widespread, inclusive, and democratized generative large models.
+
+The vision of OpenCSG is to empower every industry, every company, and every individual to own their models. We adhere to the principles of openness and open source, making the large model software stack of OpenCSG available to the community. We welcome everyone to use, send feedback, and contribute collaboratively.
+
+
+
+## Model Description
+
+The [StarCoder](https://huggingface.co/bigcode/starcoder) models are 15.5B parameter models trained on 80+ programming languages from [The Stack (v1.2)](https://huggingface.co/datasets/bigcode/the-stack), with opt-out requests excluded.
+Based on StarCoder2, opencsg-starcoder2-15b-v0.1 was fintuned by OpenCSG LLM Research Team througth full-paramters fine-tuning method.
+<br>
+
+
+## Model Eval
+
+HumanEval is the most common code generation benchmark for evaluating model performance, especially on the compeltion of code exercise cases.
+Model evaluation is, to some extent, a metaphysics. Different models have different sensitivities to decoding methods, parameters and instructions.
+It is impratical for us to manually set specific configurations for each fine-tuned model, because a real LLM should master general capabilities despite the parameters being manipulated by users.
+
+Therefore, OpenCSG racked their brains to provide a relatively fair method to compare the fine-tuned models on the HumanEval benchmark.
+To simplify the comparison, we chosed the Pass@1 metric for the Python language, but our fine-tuning dataset includes samples in multiple languages.
+
+**For fairness, we evaluated the original and fine-tuned StarCoder models based only on the prompts from the original cases, without including any other instructions.**
+
+**Otherwise, we use the greedy decoding method for each model during evaluation.**
+
+| Model     | HumanEval python pass@1                                                 |
+| ---  |----------------------------------------------------------------------------- |
+| starcoder  | 35.98%|
+| opencsg-starcoder-v0.1| **42.68%** |
+| opencsg-starcoder2-3b-v0.1| **45.12%** |
+| opencsg-starcoder2-7b-v0.1| **51.22%** |
+| opencsg-starcoder2-15b-v0.1| **59.15%** |
+
+**TODO**
+- We will provide more benchmark scores on fine-tuned models in the future.
+- We will provide different practical problems to evaluate the performance of fine-tuned models in the field of software engineering.
+
+
+
+# Model Usage
+
+
+```python
+from transformers import AutoTokenizer
+import transformers
+import torch
+
+model = "opencsg/opencsg-starcoder2-15b-v0.1"
+
+tokenizer = AutoTokenizer.from_pretrained(model, trust_remote_code=True)
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model,
+    torch_dtype=torch.float16,
+    device_map="auto",
+)
+input_text = """#Generate one test case for the following code.
+def quick_sort(arr):
+    if len(arr) < 2:
+        return arr
+    else:
+        pivot = arr[0]
+        less = [i for i in arr[1:] if i <= pivot]
+        greater = [i for i in arr[1:] if i > pivot]
+        return quick_sort(less) + [pivot] + quick_sort(greater)
+"""
+sequences = pipeline(
+    input_text,
+    do_sample=False,
+    top_k=10,
+    temperature=0.1,
+    top_p=0.95,
+    num_return_sequences=1,
+    eos_token_id=tokenizer.eos_token_id,
+    max_length=256,
+)
+for seq in sequences:
+    print(seq['generated_text'][len(input_text):])
+```
+
+**generate output**
+
+```python
+# Test case
+arr = [5, 2, 9, 1, 7]
+print(quick_sort(arr))
+
+```
+
+# Training
+
+## Hardware
+
+- **GPUs:** 8 Tesla A800 
+- **Training time:** 7 hours
+
+## Software
+
+- **Orchestration:** [Deepspeed](https://github.com/OpenCSGs)
+- **Neural networks:** [PyTorch](https://github.com/pytorch/pytorch)
+- **BP16 if applicable:** [apex](https://github.com/NVIDIA/apex)
+
+
+<a id="chinese"></a>
+
+<p>
+
+</p>
+
+# OpenCSG介绍
+
+
+<p align="center">
+<img width="300px" alt="OpenCSG" src="https://cdn-uploads.huggingface.co/production/uploads/64c71b27d43e4dee51a8b31a/GwYXPKuEoGCGcMICeW-sb.jpeg">
+</p>
+
+<p align="center"><a href="https://opencsg.com/models">[OpenCSG 社区]</a>   <a href="https://github.com/opencsgs">[github]</a>  <a href="https://cdn-uploads.huggingface.co/production/uploads/64c71b27d43e4dee51a8b31a/HU6vz21qKTEmUBCWqCFh9.jpeg">[微信]</a>  <a href="https://twitter.com/OpenCsg">[推特]</a> </p>
+
+
+
+</div>
+OpenCSG 致力于资源融合、软件求精和生成式 LM。其中，“C”代表资源融合（Converged resources），表示多种混合资源的整合和充分利用。 “S”代表软件求精（Software refinement），表示通过大模型精炼过的软件。 “G”代表生成型语言模型（Generative LM），它表示广泛使用的、包容性的、经过民主化的生成式大模型。
+
+OpenCSG 的愿景是让每个行业、每个公司、每个人都拥有自己的模型。 我们坚持开放开源的原则，将OpenCSG的大模型栈提供给社区。 欢迎大家积极使用、反馈想法和贡献内容。
+
+
+
+## 模型介绍
+[StarCoder](https://huggingface.co/bigcode/starcoder) 模型是在 [The Stack (v1.2)](https://huggingface.co/datasets/bigcode/the-stack) 中的 80 多种编程语言上训练的 155 亿参数模型，不包括用户请求排除在训练数据之外的部分。
+opencsg-starcoder2-15b-v0.1是 OpenCSG 大模型研究团队基于 StarCoder2，通过全参数微调的方法进行调优的。
+
+## 模型评估
+
+HumanEval 是评估模型在代码生成方面性能的最常见的基准，尤其是在代码习题的补全方面。
+模型评估在某种程度上是一种玄学。不同的模型对解码方法、参数和指令的敏感度不同，
+优秀的大模型是具备通用能力的，而不会因为解码参数的调整使得模型的生成表现有很大的差异。
+
+因此，OpenCSG 提供了一个相对公平的方法来在 HumanEval 基准上比较各微调模型。
+方便起见，我们选择了Python语言Pass@1指标，但要注意的是，我们的微调数据集是包含多种编程语言。
+
+**为了公平起见，我们仅根据原始问题的提示来评估原始和微调过的 StarCoder 模型，不包含任何其他说明。**
+
+**除此之外，我们在评估过程中对每个模型都使用贪婪解码方法。**
+
+| 模型     | HumanEval python pass@1                                                 |
+| ---  |----------------------------------------------------------------------------- |
+| starcoder  | 35.98%|
+| opencsg-starcoder-v0.1| **42.68%** |
+| opencsg-starcoder2-3b-v0.1| **45.12%** |
+| opencsg-starcoder2-7b-v0.1| **51.22%** |
+| opencsg-starcoder2-15b-v0.1| **59.15%** |
+
+**TODO**
+- 未来我们将提供更多微调模型的在各基准上的分数。
+- 我们将提供不同的实际问题来评估微调模型在软件工程领域的性能。
+
+
+
+# 模型使用
+
+
+```python
+from transformers import AutoTokenizer
+import transformers
+import torch
+
+model = "opencsg/opencsg-starcoder2-15b-v0.1"
+
+tokenizer = AutoTokenizer.from_pretrained(model, trust_remote_code=True)
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model,
+    torch_dtype=torch.float16,
+    device_map="auto",
+)
+input_text = """#Generate one test case for the following code.
+def quick_sort(arr):
+    if len(arr) < 2:
+        return arr
+    else:
+        pivot = arr[0]
+        less = [i for i in arr[1:] if i <= pivot]
+        greater = [i for i in arr[1:] if i > pivot]
+        return quick_sort(less) + [pivot] + quick_sort(greater)
+"""
+sequences = pipeline(
+    input_text,
+    do_sample=False,
+    top_k=10,
+    temperature=0.1,
+    top_p=0.95,
+    num_return_sequences=1,
+    eos_token_id=tokenizer.eos_token_id,
+    max_length=256,
+)
+for seq in sequences:
+    print(seq['generated_text'][len(input_text):])
+```
+
+**generate output**
+
+```python
+# Test case
+arr = [5, 2, 9, 1, 7]
+print(quick_sort(arr))
+
+```
+
+
+# 训练
+
+## 硬件资源
+
+- **GPU数量：** 8 Tesla A800 
+- **训练时间：** 7 小时
+
+## 软件使用
+
+- **微调训练框架：** [Deepspeed](https://github.com/OpenCSGs)
+- **深度学习框架：** [PyTorch](https://github.com/pytorch/pytorch)
+- **BP16：** [apex](https://github.com/NVIDIA/apex)