Akahsizrr commited on
Commit
4892833
·
verified ·
1 Parent(s): 251fde5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -196
README.md CHANGED
@@ -3,208 +3,57 @@ base_model: unsloth/qwen2.5-coder-7b-instruct-bnb-4bit
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/qwen2.5-coder-7b-instruct-bnb-4bit
 
 
 
7
  - lora
8
- - sft
9
- - transformers
10
- - trl
11
  - unsloth
 
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
 
 
19
 
20
  ## Model Details
21
-
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
-
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
 
84
  ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
-
207
- [More Information Needed]
208
- ### Framework versions
209
-
210
- - PEFT 0.18.1
 
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
+ - minecraft
7
+ - java
8
+ - spigot
9
+ - papermc
10
  - lora
 
 
 
11
  - unsloth
12
+ - qwen2.5-coder
13
  ---
14
 
15
+ # toncode-v1: Minecraft Plugin Coder
 
 
 
16
 
17
+ This model is a fine-tuned LoRA adapter for **Qwen2.5-Coder-7B-Instruct**, specialized in generating high-quality Java code for Minecraft server plugins (Spigot/Paper API).
18
 
19
  ## Model Details
20
+ - **Developed by:** Akahsizrr
21
+ - **Model type:** LoRA Adapter (PEFT)
22
+ - **Base Model:** Qwen/Qwen2.5-Coder-7B-Instruct
23
+ - **Language(s):** English, Java (Minecraft Spigot/Paper API)
24
+ - **License:** Apache-2.0
25
+ - **Finetuned from model:** unsloth/qwen2.5-coder-7b-instruct-bnb-4bit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
 
27
  ## Training Details
28
+ The model was trained using **Unsloth** on a Minecraft-specific dataset containing optimized plugin logic and event handling.
29
+
30
+ - **Training Steps:** 100
31
+ - **Optimizer:** AdamW 8-bit
32
+ - **Learning Rate:** 2e-4
33
+ - **Hardware:** 2x NVIDIA T4 (Kaggle)
34
+ - **Batch Size:** 1 (with Gradient Accumulation Steps: 8)
35
+
36
+ ## How to Get Started
37
+ To use this model, you need to load it as an adapter on top of the base Qwen2.5-Coder model using the `peft` or `unsloth` library.
38
+
39
+ ```python
40
+ from unsloth import FastLanguageModel
41
+ import torch
42
+
43
+ model, tokenizer = FastLanguageModel.from_pretrained(
44
+ model_name = "unsloth/qwen2.5-coder-7b-instruct-bnb-4bit",
45
+ max_seq_length = 2048,
46
+ load_in_4bit = True,
47
+ )
48
+
49
+ # Load your fine-tuned adapter
50
+ model = FastLanguageModel.for_inference(model)
51
+ model.load_adapter("Akahsizrr/toncode-v1")
52
+
53
+ # Test prompt
54
+ instruction = "Create a listener that gives a player a Diamond Sword when they first join the server."
55
+ messages = [{"role": "user", "content": instruction}]
56
+ inputs = tokenizer.apply_chat_template(messages, add_generation_prompt=True, return_tensors="pt").to("cuda")
57
+
58
+ outputs = model.generate(input_ids=inputs, max_new_tokens=512)
59
+ print(tokenizer.batch_decode(outputs)[0])