RichardErkhov commited on
Commit
819216d
•
1 Parent(s): 53fcdff

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +162 -0
README.md ADDED
@@ -0,0 +1,162 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ Magicoder-S-DS-6.7B - GGUF
11
+ - Model creator: https://huggingface.co/ise-uiuc/
12
+ - Original model: https://huggingface.co/ise-uiuc/Magicoder-S-DS-6.7B/
13
+
14
+
15
+ | Name | Quant method | Size |
16
+ | ---- | ---- | ---- |
17
+ | [Magicoder-S-DS-6.7B.Q2_K.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q2_K.gguf) | Q2_K | 2.36GB |
18
+ | [Magicoder-S-DS-6.7B.IQ3_XS.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.IQ3_XS.gguf) | IQ3_XS | 2.61GB |
19
+ | [Magicoder-S-DS-6.7B.IQ3_S.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.IQ3_S.gguf) | IQ3_S | 2.75GB |
20
+ | [Magicoder-S-DS-6.7B.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q3_K_S.gguf) | Q3_K_S | 2.75GB |
21
+ | [Magicoder-S-DS-6.7B.IQ3_M.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.IQ3_M.gguf) | IQ3_M | 2.9GB |
22
+ | [Magicoder-S-DS-6.7B.Q3_K.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q3_K.gguf) | Q3_K | 3.07GB |
23
+ | [Magicoder-S-DS-6.7B.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q3_K_M.gguf) | Q3_K_M | 3.07GB |
24
+ | [Magicoder-S-DS-6.7B.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q3_K_L.gguf) | Q3_K_L | 3.35GB |
25
+ | [Magicoder-S-DS-6.7B.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.IQ4_XS.gguf) | IQ4_XS | 3.4GB |
26
+ | [Magicoder-S-DS-6.7B.Q4_0.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q4_0.gguf) | Q4_0 | 3.56GB |
27
+ | [Magicoder-S-DS-6.7B.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.IQ4_NL.gguf) | IQ4_NL | 3.59GB |
28
+ | [Magicoder-S-DS-6.7B.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q4_K_S.gguf) | Q4_K_S | 3.59GB |
29
+ | [Magicoder-S-DS-6.7B.Q4_K.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q4_K.gguf) | Q4_K | 3.8GB |
30
+ | [Magicoder-S-DS-6.7B.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q4_K_M.gguf) | Q4_K_M | 3.8GB |
31
+ | [Magicoder-S-DS-6.7B.Q4_1.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q4_1.gguf) | Q4_1 | 3.95GB |
32
+ | [Magicoder-S-DS-6.7B.Q5_0.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q5_0.gguf) | Q5_0 | 4.33GB |
33
+ | [Magicoder-S-DS-6.7B.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q5_K_S.gguf) | Q5_K_S | 4.33GB |
34
+ | [Magicoder-S-DS-6.7B.Q5_K.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q5_K.gguf) | Q5_K | 4.46GB |
35
+ | [Magicoder-S-DS-6.7B.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q5_K_M.gguf) | Q5_K_M | 4.46GB |
36
+ | [Magicoder-S-DS-6.7B.Q5_1.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q5_1.gguf) | Q5_1 | 4.72GB |
37
+ | [Magicoder-S-DS-6.7B.Q6_K.gguf](https://huggingface.co/RichardErkhov/ise-uiuc_-_Magicoder-S-DS-6.7B-gguf/blob/main/Magicoder-S-DS-6.7B.Q6_K.gguf) | Q6_K | 5.15GB |
38
+
39
+
40
+
41
+
42
+ Original model description:
43
+ ---
44
+ license: other
45
+ library_name: transformers
46
+ datasets:
47
+ - ise-uiuc/Magicoder-OSS-Instruct-75K
48
+ - ise-uiuc/Magicoder-Evol-Instruct-110K
49
+ license_name: deepseek
50
+ pipeline_tag: text-generation
51
+ ---
52
+ # 🎩 Magicoder: Source Code Is All You Need
53
+
54
+ > Refer to our GitHub repo [ise-uiuc/magicoder](https://github.com/ise-uiuc/magicoder/) for an up-to-date introduction to the Magicoder family!
55
+
56
+ * 🎩**Magicoder** is a model family empowered by 🪄**OSS-Instruct**, a novel approach to enlightening LLMs with open-source code snippets for generating *low-bias* and *high-quality* instruction data for code.
57
+ * 🪄**OSS-Instruct** mitigates the *inherent bias* of the LLM-synthesized instruction data by empowering them with *a wealth of open-source references* to produce more diverse, realistic, and controllable data.
58
+
59
+ ![Overview of OSS-Instruct](assets/overview.svg)
60
+ ![Overview of Result](assets/result.png)
61
+
62
+ ## Model Details
63
+
64
+ ### Model Description
65
+
66
+ * **Developed by:**
67
+ [Yuxiang Wei](https://yuxiang.cs.illinois.edu),
68
+ [Zhe Wang](https://github.com/zhewang2001),
69
+ [Jiawei Liu](https://jiawei-site.github.io),
70
+ [Yifeng Ding](https://yifeng-ding.com),
71
+ [Lingming Zhang](https://lingming.cs.illinois.edu)
72
+ * **License:** [DeepSeek](https://github.com/deepseek-ai/DeepSeek-Coder/blob/main/LICENSE-MODEL)
73
+ * **Finetuned from model:** [deepseek-coder-6.7b-base](https://huggingface.co/deepseek-ai/deepseek-coder-6.7b-base)
74
+
75
+ ### Model Sources
76
+
77
+ * **Repository:** <https://github.com/ise-uiuc/magicoder>
78
+ * **Paper:** <https://arxiv.org/abs/2312.02120>
79
+ * **Demo (powered by [Gradio](https://www.gradio.app)):**
80
+ <https://github.com/ise-uiuc/magicoder/tree/main/demo>
81
+
82
+ ### Training Data
83
+
84
+ * [Magicoder-OSS-Instruct-75K](https://huggingface.co/datasets/ise-uiuc/Magicoder_oss_instruct_75k): generated through **OSS-Instruct** using `gpt-3.5-turbo-1106` and used to train both Magicoder and Magicoder-S series.
85
+ * [Magicoder-Evol-Instruct-110K](https://huggingface.co/datasets/ise-uiuc/Magicoder_evol_instruct_110k): decontaminated and redistributed from [theblackcat102/evol-codealpaca-v1](https://huggingface.co/datasets/theblackcat102/evol-codealpaca-v1), used to further finetune Magicoder series and obtain Magicoder-S models.
86
+
87
+ ## Uses
88
+
89
+ ### Direct Use
90
+
91
+ Magicoders are designed and best suited for **coding tasks**.
92
+
93
+ ### Out-of-Scope Use
94
+
95
+ Magicoders may not work well in non-coding tasks.
96
+
97
+ ## Bias, Risks, and Limitations
98
+
99
+ Magicoders may sometimes make errors, producing misleading contents, or struggle to manage tasks that are not related to coding.
100
+
101
+ ### Recommendations
102
+
103
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.
104
+
105
+ ## How to Get Started with the Model
106
+
107
+ Use the code below to get started with the model. Make sure you installed the [transformers](https://huggingface.co/docs/transformers/index) library.
108
+
109
+ ```python
110
+ from transformers import pipeline
111
+ import torch
112
+
113
+ MAGICODER_PROMPT = """You are an exceptionally intelligent coding assistant that consistently delivers accurate and reliable responses to user instructions.
114
+
115
+ @@ Instruction
116
+ {instruction}
117
+
118
+ @@ Response
119
+ """
120
+
121
+ instruction = <Your code instruction here>
122
+
123
+ prompt = MAGICODER_PROMPT.format(instruction=instruction)
124
+ generator = pipeline(
125
+ model="ise-uiuc/Magicoder-S-DS-6.7B",
126
+ task="text-generation",
127
+ torch_dtype=torch.bfloat16,
128
+ device_map="auto",
129
+ )
130
+ result = generator(prompt, max_length=1024, num_return_sequences=1, temperature=0.0)
131
+ print(result[0]["generated_text"])
132
+ ```
133
+
134
+ ## Technical Details
135
+
136
+ Refer to our GitHub repo: [ise-uiuc/magicoder](https://github.com/ise-uiuc/magicoder/).
137
+
138
+ ## Citation
139
+
140
+ ```bibtex
141
+ @misc{magicoder,
142
+ title={Magicoder: Source Code Is All You Need},
143
+ author={Yuxiang Wei and Zhe Wang and Jiawei Liu and Yifeng Ding and Lingming Zhang},
144
+ year={2023},
145
+ eprint={2312.02120},
146
+ archivePrefix={arXiv},
147
+ primaryClass={cs.CL}
148
+ }
149
+ ```
150
+
151
+ ## Acknowledgements
152
+
153
+ * [WizardCoder](https://github.com/nlpxucan/WizardLM/tree/main/WizardCoder): Evol-Instruct
154
+ * [DeepSeek-Coder](https://github.com/deepseek-ai/DeepSeek-Coder): Base model for Magicoder-DS
155
+ * [CodeLlama](https://ai.meta.com/research/publications/code-llama-open-foundation-models-for-code/): Base model for Magicoder-CL
156
+ * [StarCoder](https://arxiv.org/abs/2305.06161): Data decontamination
157
+
158
+ ## Important Note
159
+
160
+ Magicoder models are trained on the synthetic data generated by OpenAI models. Please pay attention to OpenAI's [terms of use](https://openai.com/policies/terms-of-use) when using the models and the datasets. Magicoders will not compete with OpenAI's commercial products.
161
+
162
+