Add missing metadata and improve formatting

This PR adds the missing `license`, `library_name`, and `pipeline_tag` to the model card's YAML metadata. It also slightly improves formatting for better readability by moving the quantization information below the original model description and reformatting the original model description for better readability.

README.md

@@ -1,3 +1,9 @@
+---
+license: apache-2.0
+library_name: transformers
+pipeline_tag: text-generation
+---
+
 Quantization made by Richard Erkhov.
 
 [Github](https://github.com/RichardErkhov)
@@ -6,23 +12,12 @@ Quantization made by Richard Erkhov.
 
 [Request more models](https://github.com/RichardErkhov/quant_request)
 
-
 CursorCore-Yi-1.5B-SR - AWQ
 - Model creator: https://huggingface.co/TechxGenus/
 - Original model: https://huggingface.co/TechxGenus/CursorCore-Yi-1.5B-SR/
 
-
-
-
 Original model description:
----
-tags:
-- code
-base_model:
-- 01-ai/Yi-Coder-1.5B
-library_name: transformers
-pipeline_tag: text-generation
-license: apache-2.0
+
 ---
 
 # CursorCore: Assist Programming through Aligning Anything
@@ -32,14 +27,15 @@ license: apache-2.0
 <a href="https://hf.co/papers/2410.07002">[🤗HF Paper]</a> |
 <a href="https://huggingface.co/collections/TechxGenus/cursorcore-series-6706618c38598468866b60e2">[🤖Models]</a> |
 <a href="https://github.com/TechxGenus/CursorCore">[🛠️Code]</a> |
-<a href="https://github.com/TechxGenus/CursorWeb">[Web]</a> |
-<a href="https://discord.gg/Z5Tev8fV">[Discord]</a>
+<a href="https://github.com/TechxGenus/CursorWeb">[<img src="https://github.com/TechxGenus/CursorCore/blob/main/pictures/cursorcore.png" width="12.5px">Web]</a> |
+<a href="https://discord.gg/Z5Tev8fV">[<img src="https://github.com/TechxGenus/CursorCore/blob/main/pictures/discord.png" width="15x">Discord]</a>
 </p>
 
 <hr>
 
 - [CursorCore: Assist Programming through Aligning Anything](#cursorcore-assist-programming-through-aligning-anything)
   - [Introduction](#introduction)
+  - [Structure](#structure)
   - [Models](#models)
   - [Usage](#usage)
     - [1) Normal chat](#1-normal-chat)
@@ -47,6 +43,7 @@ license: apache-2.0
     - [3) Web Demo](#3-web-demo)
   - [Future Work](#future-work)
   - [Citation](#citation)
+  - [Acknowledgements](#acknowledgements)
   - [Contribution](#contribution)
 
 <hr>
@@ -56,15 +53,43 @@ license: apache-2.0
 CursorCore is a series of open-source models designed for AI-assisted programming. It aims to support features such as automated editing and inline chat, replicating the core abilities of closed-source AI-assisted programming tools like Cursor. This is achieved by aligning data generated through Programming-Instruct. Please read [our paper](http://arxiv.org/abs/2410.07002) to learn more.
 
 <p align="center">
-<img width="100%" alt="conversation" src="https://raw.githubusercontent.com/TechxGenus/CursorCore/main/pictures/conversation.png">
+<img width="100%" alt="conversation" src="https://github.com/TechxGenus/CursorCore/blob/main/pictures/conversation.png">
 </p>
 
-![CursorWeb](https://raw.githubusercontent.com/TechxGenus/CursorCore/main/pictures/CursorWeb.gif)
+![CursorWeb](https://github.com/TechxGenus/CursorCore/blob/main/pictures/CursorWeb.gif)
+
+## Structure
+
+- `./benchmark` contains the APEval benchmark
+- `./data` contains code to preprocess datasets
+- `./eval` contains code to evaluate models
+- `./gen` contains code to prompt LLMs for generation
+- `./generic` common functions, tools and special tokens
+- `./src` contains code about Programming-Instruct
+- `./train` contains code for training CursorCore
+
+Please ensure all dependencies are installed using the following command:
+
+```bash
+pip install -r requirements.txt
+```
+
+We also use [flash-attention](https://github.com/Dao-AILab/flash-attention) for efficient training and [flashinfer](https://github.com/flashinfer-ai/flashinfer) to accelerate inference. See the documents for them to learn how to install.
 
 ## Models
 
 Our models have been open-sourced on Hugging Face. You can access our models here: [CursorCore-Series](https://huggingface.co/collections/TechxGenus/cursorcore-series-6706618c38598468866b60e2"). We also provide pre-quantized weights for GPTQ and AWQ here: [CursorCore-Quantization](https://huggingface.co/collections/TechxGenus/cursorcore-quantization-67066431f29f252494ee8cf3)
 
+We use the manually written benchmark APEval to assess the model's ability to assist programming. We also utilize [EvalPlus](https://github.com/evalplus/evalplus), [CanItEdit](https://github.com/nuprl/CanItEdit) and [OctoPack](https://github.com/bigcode-project/octopack) to evaluate the model's performance in Python program generation, instructional code editing, and automated program repair. Since we use a custom conversation template, its generation method differs significantly from both instruct models and base models. Please refer to [our paper](http://arxiv.org/abs/2410.07002) for more details.
+
+Evaluation results on APEval:
+
+<img src="https://github.com/TechxGenus/CursorCore/blob/main/pictures/APEval.png" alt="APEval" width="75%"/>
+
+Evaluation results on EvalPlus, CanItEdit and OctoPack:
+
+<img src="https://github.com/TechxGenus/CursorCore/blob/main/pictures/EvalPlus_CanItEdit_OctoPack.png" alt="EvalPlus_CanItEdit_OctoPack" width="75%">
+
 ## Usage
 
 Here are some examples of how to use our model:
@@ -131,13 +156,27 @@ sample = {
         {
             "type": "code",
             "lang": "python",
-            "code": """def quick_sort(arr):\n    if len(arr) <= 1:\n        return arr\n    pivot = arr[len(arr) // 2]\n    left = [x for x in arr if x < pivot]\n    middle = [x for x in arr if x == pivot]\n    right = [x for x in arr if x > pivot]\n    return quick_sort(left) + middle + quick_sort(right)"""
+            "code": """def quick_sort(arr):
+    if len(arr) <= 1:
+        return arr
+    pivot = arr[len(arr) // 2]
+    left = [x for x in arr if x < pivot]
+    middle = [x for x in arr if x == pivot]
+    right = [x for x in arr if x > pivot]
+    return quick_sort(left) + middle + quick_sort(right)"""
         }
     ],
     "current": {
         "type": "code",
         "lang": "python",
-        "code": """def quick_sort(array):\n    if len(arr) <= 1:\n        return arr\n    pivot = arr[len(arr) // 2]\n    left = [x for x in arr if x < pivot]\n    middle = [x for x in arr if x == pivot]\n    right = [x for x in arr if x > pivot]\n    return quick_sort(left) + middle + quick_sort(right)"""
+        "code": """def quick_sort(array):
+    if len(arr) <= 1:
+        return arr
+    pivot = arr[len(arr) // 2]
+    left = [x for x in arr if x < pivot]
+    middle = [x for x in arr if x == pivot]
+    right = [x for x in arr if x > pivot]
+    return quick_sort(left) + middle + quick_sort(right)"""
     },
     "user": ""
 }
@@ -219,7 +258,14 @@ sample = {
     "current": {
         "type": "code",
         "lang": "python",
-        "code": """def quick_sort(array):\n    if len(arr) <= 1:\n        return arr\n    pivot = arr[len(arr) // 2]\n    left = [x for x in arr if x < pivot]\n    middle = [x for x in arr if x == pivot]\n    right = [x for x in arr if x > pivot]\n    return quick_sort(left) + middle + quick_sort(right)"""
+        "code": """def quick_sort(array):
+    if len(arr) <= 1:
+        return arr
+    pivot = arr[len(arr) // 2]
+    left = [x for x in arr if x < pivot]
+    middle = [x for x in arr if x == pivot]
+    right = [x for x in arr if x > pivot]
+    return quick_sort(left) + middle + quick_sort(right)"""
     },
     "user": "Add Docstring."
 }
@@ -290,7 +336,14 @@ sample = {
     "current": {
         "type": "code",
         "lang": "python",
-        "code": """def quick_sort(array):\n    if len(arr) <= 1:\n        return arr\n    pivot = arr[len(arr) // 2]\n    left = [x for x in arr if x < pivot]\n    middle = [x for x in arr if x == pivot]\n    right = [x for x in arr if x > pivot]\n    return quick_sort(left) + middle + quick_sort(right)"""
+        "code": """def quick_sort(array):
+    if len(arr) <= 1:
+        return arr
+    pivot = arr[len(arr) // 2]
+    left = [x for x in arr if x < pivot]
+    middle = [x for x in arr if x == pivot]
+    right = [x for x in arr if x > pivot]
+    return quick_sort(left) + middle + quick_sort(right)"""
     },
     "user": "Add Docstring."
 }
@@ -359,7 +412,14 @@ sample = {
     "current": {
         "type": "code",
         "lang": "python",
-        "code": """def quick_sort(array):\n    if len(arr) <= 1:\n        return arr\n    pivot = arr[len(arr) // 2]\n    left = [x for x in arr if x < pivot]\n    middle = [x for x in arr if x == pivot]\n    right = [x for x in arr if x > pivot]\n    return quick_sort(left) + middle + quick_sort(right)"""
+        "code": """def quick_sort(array):
+    if len(arr) <= 1:
+        return arr
+    pivot = arr[len(arr) // 2]
+    left = [x for x in arr if x < pivot]
+    middle = [x for x in arr if x == pivot]
+    right = [x for x in arr if x > pivot]
+    return quick_sort(left) + middle + quick_sort(right)"""
     },
     "user": "Add Docstring."
 }
@@ -429,8 +489,12 @@ CursorCore is still in a very early stage, and lots of work is needed to achieve
 }
 ```
 
-## Contribution
+## Acknowledgements
+
+The open-source community has been of great help to us, and we reference numerous projects and applications. They include but are not limited to:
 
-Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.
+[Deepseek-Coder](https://github.com/deepseek-ai/DeepSeek-Coder), [Yi-Coder](https://github.com/01-ai/Yi-Coder), [Qwen-Coder](https://github.com/QwenLM/Qwen2.5-Coder), [Self-Instruct](https://github.com/yizhongw/self-instruct), [Evol-Instruct](https://github.com/theblackcat102/evol-dataset), [OSS-Instruct](https://github.com/ise-uiuc/magicoder), [EvalPlus](https://github.com/evalplus/evalplus), [CanItEdit](https://github.com/nuprl/CanItEdit), [OctoPack](https://github.com/bigcode-project/octopack), [Aider](https://github.com/Aider-AI/aider), [Continue](https://github.com/continuedev/continue), [Cursor](https://github.com/getcursor/cursor), ...
 
+## Contribution
 
+Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.