kangsyahrul commited on
Commit
bec76a0
·
verified ·
1 Parent(s): 52519d4

Add model card and adapter usage guidance

Browse files
Files changed (1) hide show
  1. README.md +56 -185
README.md CHANGED
@@ -1,208 +1,79 @@
1
  ---
2
- base_model: unsloth/qwen2.5-coder-3b-instruct-bnb-4bit
 
3
  library_name: peft
 
 
 
 
 
 
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/qwen2.5-coder-3b-instruct-bnb-4bit
7
  - lora
 
8
  - transformers
9
  - unsloth
 
 
10
  ---
11
 
12
- # Model Card for Model ID
13
 
14
- <!-- Provide a quick summary of what the model is/does. -->
 
 
15
 
 
 
16
 
 
17
 
18
- ## Model Details
 
 
 
 
 
 
 
 
 
19
 
20
- ### Model Description
 
21
 
22
- <!-- Provide a longer summary of what this model is. -->
23
 
 
 
 
24
 
 
 
25
 
26
- - **Developed by:** [More Information Needed]
27
- - **Funded by [optional]:** [More Information Needed]
28
- - **Shared by [optional]:** [More Information Needed]
29
- - **Model type:** [More Information Needed]
30
- - **Language(s) (NLP):** [More Information Needed]
31
- - **License:** [More Information Needed]
32
- - **Finetuned from model [optional]:** [More Information Needed]
 
33
 
34
- ### Model Sources [optional]
 
 
35
 
36
- <!-- Provide the basic links for the model. -->
37
 
38
- - **Repository:** [More Information Needed]
39
- - **Paper [optional]:** [More Information Needed]
40
- - **Demo [optional]:** [More Information Needed]
 
41
 
42
- ## Uses
43
 
44
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
45
-
46
- ### Direct Use
47
-
48
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
49
-
50
- [More Information Needed]
51
-
52
- ### Downstream Use [optional]
53
-
54
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
-
56
- [More Information Needed]
57
-
58
- ### Out-of-Scope Use
59
-
60
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
61
-
62
- [More Information Needed]
63
-
64
- ## Bias, Risks, and Limitations
65
-
66
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
67
-
68
- [More Information Needed]
69
-
70
- ### Recommendations
71
-
72
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
73
-
74
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
75
-
76
- ## How to Get Started with the Model
77
-
78
- Use the code below to get started with the model.
79
-
80
- [More Information Needed]
81
-
82
- ## Training Details
83
-
84
- ### Training Data
85
-
86
- <!-- 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. -->
87
-
88
- [More Information Needed]
89
-
90
- ### Training Procedure
91
-
92
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
93
-
94
- #### Preprocessing [optional]
95
-
96
- [More Information Needed]
97
-
98
-
99
- #### Training Hyperparameters
100
-
101
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
102
-
103
- #### Speeds, Sizes, Times [optional]
104
-
105
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
106
-
107
- [More Information Needed]
108
-
109
- ## Evaluation
110
-
111
- <!-- This section describes the evaluation protocols and provides the results. -->
112
-
113
- ### Testing Data, Factors & Metrics
114
-
115
- #### Testing Data
116
-
117
- <!-- This should link to a Dataset Card if possible. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Factors
122
-
123
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
124
-
125
- [More Information Needed]
126
-
127
- #### Metrics
128
-
129
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
130
-
131
- [More Information Needed]
132
-
133
- ### Results
134
-
135
- [More Information Needed]
136
-
137
- #### Summary
138
-
139
-
140
-
141
- ## Model Examination [optional]
142
-
143
- <!-- Relevant interpretability work for the model goes here -->
144
-
145
- [More Information Needed]
146
-
147
- ## Environmental Impact
148
-
149
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
150
-
151
- 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).
152
-
153
- - **Hardware Type:** [More Information Needed]
154
- - **Hours used:** [More Information Needed]
155
- - **Cloud Provider:** [More Information Needed]
156
- - **Compute Region:** [More Information Needed]
157
- - **Carbon Emitted:** [More Information Needed]
158
-
159
- ## Technical Specifications [optional]
160
-
161
- ### Model Architecture and Objective
162
-
163
- [More Information Needed]
164
-
165
- ### Compute Infrastructure
166
-
167
- [More Information Needed]
168
-
169
- #### Hardware
170
-
171
- [More Information Needed]
172
-
173
- #### Software
174
-
175
- [More Information Needed]
176
-
177
- ## Citation [optional]
178
-
179
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
180
-
181
- **BibTeX:**
182
-
183
- [More Information Needed]
184
-
185
- **APA:**
186
-
187
- [More Information Needed]
188
-
189
- ## Glossary [optional]
190
-
191
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
192
-
193
- [More Information Needed]
194
-
195
- ## More Information [optional]
196
-
197
- [More Information Needed]
198
-
199
- ## Model Card Authors [optional]
200
-
201
- [More Information Needed]
202
-
203
- ## Model Card Contact
204
-
205
- [More Information Needed]
206
- ### Framework versions
207
-
208
- - PEFT 0.18.1
 
1
  ---
2
+ base_model: Qwen/Qwen2.5-Coder-3B-Instruct
3
+ base_model_relation: adapter
4
  library_name: peft
5
+ license: other
6
+ license_name: qwen-research
7
+ license_link: https://huggingface.co/Qwen/Qwen2.5-Coder-3B-Instruct/blob/main/LICENSE
8
+ language:
9
+ - en
10
+ - id
11
  pipeline_tag: text-generation
12
  tags:
 
13
  - lora
14
+ - peft
15
  - transformers
16
  - unsloth
17
+ - qwen
18
+ - qwen-coder
19
  ---
20
 
21
+ # Dendriva Qwen2.5-Coder 3B Instruct — LoRA
22
 
23
+ PEFT LoRA adapter trained from `Qwen/Qwen2.5-Coder-3B-Instruct`. This is the
24
+ lightweight, trainable-format export for Unsloth or Transformers. It requires
25
+ the base model at load time.
26
 
27
+ The ready-to-run LM Studio quantization is available in
28
+ `kangsyahrul/dendriva-qwen2.5-coder-3b-instruct-gguf`.
29
 
30
+ ## Training provenance
31
 
32
+ - Selected checkpoint: `checkpoint-69`
33
+ - Epochs: 3
34
+ - Steps: 69
35
+ - Context length: 32,768
36
+ - LoRA rank / alpha / dropout: 16 / 16 / 0
37
+ - Learning rate: 2e-4
38
+ - Batch size: 2
39
+ - Optimizer: AdamW 8-bit
40
+ - Warmup steps: 3
41
+ - Training tokens reported by Unsloth Studio: 8,927,658
42
 
43
+ The repository intentionally excludes optimizer, scheduler, RNG, and trainer
44
+ state because those are not required for local inference.
45
 
46
+ ## Load with Transformers and PEFT
47
 
48
+ ```python
49
+ from transformers import AutoModelForCausalLM, AutoTokenizer
50
+ from peft import PeftModel
51
 
52
+ base_id = "Qwen/Qwen2.5-Coder-3B-Instruct"
53
+ adapter_id = "kangsyahrul/dendriva-qwen2.5-coder-3b-instruct-lora"
54
 
55
+ tokenizer = AutoTokenizer.from_pretrained(adapter_id)
56
+ base_model = AutoModelForCausalLM.from_pretrained(
57
+ base_id,
58
+ torch_dtype="auto",
59
+ device_map="auto",
60
+ )
61
+ model = PeftModel.from_pretrained(base_model, adapter_id)
62
+ ```
63
 
64
+ In Unsloth Desktop, use the Hugging Face model source and enter the full adapter
65
+ repository ID. Authenticate with a Hugging Face token because the repository is
66
+ private.
67
 
68
+ ## Evaluation status
69
 
70
+ The adapter files and tokenizer were verified after upload. The training run
71
+ completed successfully, but no comprehensive held-out coding or Manim benchmark
72
+ is published with this repository. Compile, render, and test generated code
73
+ before use.
74
 
75
+ ## License
76
 
77
+ This derivative follows the Qwen Research License of the base model. Review the
78
+ [base-model license](https://huggingface.co/Qwen/Qwen2.5-Coder-3B-Instruct/blob/main/LICENSE)
79
+ before redistribution or commercial use.