Ayushnangia commited on
Commit
f3011df
·
verified ·
1 Parent(s): cabc838

Add model card

Browse files
Files changed (1) hide show
  1. README.md +89 -167
README.md CHANGED
@@ -1,199 +1,121 @@
1
  ---
 
 
 
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
 
 
 
11
 
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
 
159
- ### Compute Infrastructure
160
 
161
- [More Information Needed]
 
 
162
 
163
- #### Hardware
 
164
 
165
- [More Information Needed]
 
166
 
167
- #### Software
 
 
 
168
 
169
- [More Information Needed]
 
 
 
 
170
 
171
- ## Citation [optional]
172
 
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
 
 
 
174
 
175
- **BibTeX:**
176
 
177
- [More Information Needed]
 
 
 
178
 
179
- **APA:**
 
 
 
180
 
181
- [More Information Needed]
 
 
 
182
 
183
- ## Glossary [optional]
 
 
 
 
 
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
 
187
- [More Information Needed]
188
 
189
- ## More Information [optional]
 
 
 
190
 
191
- [More Information Needed]
 
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
 
 
196
 
197
- ## Model Card Contact
198
 
199
- [More Information Needed]
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
  library_name: transformers
6
+ tags:
7
+ - modernbert
8
+ - diffusion
9
+ - masked-language-model
10
+ - text-generation
11
+ base_model: answerdotai/ModernBERT-large
12
+ datasets:
13
+ - Ayushnangia/dolci-diffusion-sft-0.9-passrate
14
+ pipeline_tag: fill-mask
15
  ---
16
 
17
+ # mb-diff-1000step
18
 
19
+ A ModernBERT-large model fine-tuned as a **diffusion language model** (LLADA-style) for instruction-following.
20
 
21
+ ## Model Description
22
 
23
+ This model uses iterative unmasking for text generation:
24
+ 1. Start with a user prompt + fully masked response slots
25
+ 2. Model predicts all masked tokens simultaneously
26
+ 3. Keep the most confident prediction, repeat until done
27
 
28
+ Unlike autoregressive models, this allows parallel token prediction and flexible generation order.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
30
  ## Training Details
31
 
32
+ - **Base model**: [answerdotai/ModernBERT-large](https://huggingface.co/answerdotai/ModernBERT-large)
33
+ - **Training data**: [Ayushnangia/dolci-diffusion-sft-0.9-passrate](https://huggingface.co/datasets/Ayushnangia/dolci-diffusion-sft-0.9-passrate) (117k high-quality examples)
34
+ - **Training steps**: 1000
35
+ - **Hardware**: H100 80GB
36
+ - **Variable masking**: 15-99% of assistant tokens masked per sample
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
+ ## Usage
39
 
40
+ ```python
41
+ import torch
42
+ from transformers import AutoTokenizer, AutoModelForMaskedLM
43
 
44
+ model_id = "Ayushnangia/mb-diff-1000step"
45
+ device = "cuda" if torch.cuda.is_available() else "cpu"
46
 
47
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
48
+ model = AutoModelForMaskedLM.from_pretrained(model_id, torch_dtype=torch.bfloat16).to(device)
49
 
50
+ # Build prompt with masked response
51
+ query = "What is 2+2?"
52
+ messages = [{"role": "user", "content": query}]
53
+ prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
54
 
55
+ # Add masked tokens for response
56
+ num_tokens = 64
57
+ prompt_ids = tokenizer.encode(prompt, add_special_tokens=False)
58
+ mask_id = tokenizer.mask_token_id
59
+ im_end_id = tokenizer.convert_tokens_to_ids("<|im_end|>")
60
 
61
+ ids = [tokenizer.cls_token_id] + prompt_ids + [mask_id] * num_tokens + [im_end_id]
62
 
63
+ # Iterative unmasking
64
+ for step in range(num_tokens):
65
+ with torch.no_grad():
66
+ input_tensor = torch.tensor([ids], device=device)
67
+ logits = model(input_ids=input_tensor).logits[0]
68
 
69
+ probs = torch.softmax(logits, dim=-1)
70
 
71
+ # Find mask positions
72
+ mask_positions = [i for i, tok in enumerate(ids) if tok == mask_id]
73
+ if not mask_positions:
74
+ break
75
 
76
+ # Get confidence for each mask position
77
+ mask_probs = torch.zeros_like(probs)
78
+ for pos in mask_positions:
79
+ mask_probs[pos] = probs[pos]
80
 
81
+ # Fill most confident prediction
82
+ max_probs, max_tokens = mask_probs.max(dim=-1)
83
+ best_pos = max_probs.argmax().item()
84
+ ids[best_pos] = max_tokens[best_pos].item()
85
 
86
+ # Decode response
87
+ response_start = len(prompt_ids) + 1
88
+ response_ids = [t for t in ids[response_start:] if t not in (mask_id, im_end_id)]
89
+ response = tokenizer.decode(response_ids, skip_special_tokens=True)
90
+ print(response)
91
+ ```
92
 
93
+ ## Inference Script
94
 
95
+ For easier inference, use the sampling script from the training repo:
96
 
97
+ ```bash
98
+ git clone https://github.com/agokrani/diffu-convert
99
+ cd diffu-convert
100
+ pip install -e .
101
 
102
+ python scripts/mb_dllm_sample.py --model Ayushnangia/mb-diff-1000step --query "What is 2+2?"
103
+ ```
104
 
105
+ ## Limitations
106
 
107
+ - Early checkpoint (1000 steps) - not fully converged
108
+ - Best for short responses (64-256 tokens)
109
+ - Math/reasoning tasks may have lower accuracy than autoregressive models
110
 
111
+ ## Citation
112
 
113
+ ```bibtex
114
+ @misc{mb-diffusion,
115
+ author = {Ayush Nangia},
116
+ title = {ModernBERT Diffusion Language Model},
117
+ year = {2025},
118
+ publisher = {HuggingFace},
119
+ url = {https://huggingface.co/Ayushnangia/mb-diff-1000step}
120
+ }
121
+ ```