joseneto023dev commited on
Commit
ef29ddc
·
verified ·
1 Parent(s): 7f31d5e

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +68 -177
README.md CHANGED
@@ -1,208 +1,99 @@
1
  ---
2
- base_model: unsloth/deepseek-r1-distill-qwen-1.5b-unsloth-bnb-4bit
3
- library_name: peft
4
- pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/deepseek-r1-distill-qwen-1.5b-unsloth-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
+ license: apache-2.0
3
+ base_model: unsloth/DeepSeek-R1-Distill-Qwen-1.5B
 
4
  tags:
5
+ - dyck
6
+ - reasoning
7
+ - brackets
8
+ - fine-tuning
9
+ - lora
10
+ - unsloth
11
+ language:
12
+ - en
13
+ datasets:
14
+ - conversation.jsonl
15
+ pipeline_tag: text-generation
16
  ---
17
 
18
+ # Dyck Completion Model (Reasoning)
 
 
 
 
 
 
 
 
 
 
 
19
 
20
+ This model is fine-tuned to **complete Dyck sequences** (balanced bracket sequences) with **step-by-step reasoning**. Given a prefix of opening brackets, it outputs the minimal closing brackets so the full sequence is a valid Dyck word.
21
 
22
+ **Response style:** Output follows the **dataset format only** (structured `# Thought N:`, `# Step k: add 'X'.`, then `FINAL ANSWER: <sequence>`). It is not intended to mimic Qwen/DeepSeek-style prose (e.g. no "Wait...", "Let me recount", or conversational commentary). Training and inference prompts enforce this dataset style.
 
 
 
 
 
 
23
 
24
+ ## Task
25
 
26
+ - **Input:** A prefix of opening brackets (e.g. `[ < (`).
27
+ - **Output:** Step-by-step reasoning, then the **complete valid Dyck sequence** (e.g. `) > ]` appended).
28
+ - **Bracket pairs:** `()`, `[]`, `{}`, `<>`
29
 
30
+ ## Base Model
 
 
31
 
32
+ - **Architecture:** [DeepSeek-R1-Distill-Qwen-1.5B](https://huggingface.co/unsloth/DeepSeek-R1-Distill-Qwen-1.5B) (Unsloth)
33
+ - **Fine-tuning:** LoRA (r=64, alpha=128, dropout=0.05) on q/k/v/o and MLP projections
34
+ - **Training:** Causal LM; loss on assistant tokens only; format: `{reasoning}\n\nFINAL ANSWER: {full_sequence}`
35
 
36
+ ## Intended Use
37
 
38
+ - Research and education on formal language (Dyck) and chain-of-thought reasoning.
39
+ - Benchmarking reasoning models on bracket completion.
40
 
41
+ ## How to Use
42
 
43
+ **Inference:** Use the **merged model** (single load, base+LoRA already merged) or load base + adapter via PEFT. Merged model = one `AutoModelForCausalLM`; computation is equivalent to base+adapter at every layer.
44
 
45
+ ### With merged model (this repo, if uploaded as merged)
46
 
47
+ ```python
48
+ from transformers import AutoModelForCausalLM, AutoTokenizer
49
 
50
+ model_id = "YOUR_USERNAME/YOUR_REPO" # e.g. akashdutta1030/dyck-deepseek-r1-lora
51
+ tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
52
+ model = AutoModelForCausalLM.from_pretrained(model_id, trust_remote_code=True)
53
 
54
+ prompt = """Complete the following Dyck language sequence by adding the minimal necessary closing brackets.
55
 
56
+ Sequence: [ < (
57
 
58
+ Rules:
59
+ - Add only the closing brackets needed to match all unmatched opening brackets
60
+ - Response format (dataset style only): Use "# Thought N: ..." for each step, then "# Step k: add 'X'.", then "FINAL ANSWER: " followed by the complete Dyck sequence. Do not add Qwen/DeepSeek-style prose or conversational commentary."""
61
 
62
+ inputs = tokenizer(prompt, return_tensors="pt")
63
+ outputs = model.generate(**inputs, max_new_tokens=256, do_sample=True, temperature=0.05)
64
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
65
+ # Parse "FINAL ANSWER: ..." from response for the completed sequence
66
+ ```
67
 
68
+ ### With LoRA adapter (load base + adapter)
69
 
70
+ ```python
71
+ from unsloth import FastLanguageModel
72
 
73
+ model, tokenizer = FastLanguageModel.from_pretrained(
74
+ model_name="unsloth/DeepSeek-R1-Distill-Qwen-1.5B",
75
+ max_seq_length=768,
76
+ )
77
+ model, tokenizer = FastLanguageModel.from_pretrained(
78
+ "YOUR_USERNAME/YOUR_REPO", # adapter repo
79
+ max_seq_length=768,
80
+ )
81
+ # Then generate as above
82
+ ```
 
83
 
84
  ## Training Details
85
 
86
+ - **Data:** JSONL conversations (user question → assistant reasoning + final answer). Dataset size configurable (e.g. 60k).
87
+ - **Split:** ~95% train, ~5% eval.
88
+ - **Sequence length:** 768 tokens (run `check_dataset_seq_len.py` to confirm max).
89
+ - **Optimization:** AdamW, cosine LR 6e-6, warmup 25%, max_grad_norm=0.5. 2 epochs typical.
90
+ - **Weighted loss:** Tokens from "FINAL ANSWER: " onward get weight 5.0; reasoning tokens 1.0 (stronger signal on the answer).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
91
 
92
+ ## Limitations
93
 
94
+ - Trained on synthetic Dyck data; may not generalize to arbitrary bracket-like tasks.
95
+ - Performance depends on prefix length and bracket vocabulary.
96
 
97
+ ## Citation
 
98
 
99
+ If you use this model, please cite the base model (DeepSeek-R1-Distill-Qwen) and this fine-tuning setup as appropriate.