hasankursun commited on
Commit
f9e62e5
·
verified ·
1 Parent(s): e7c3dd3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -43
README.md CHANGED
@@ -11,7 +11,7 @@ tags:
11
  - rmsnorm
12
  - swiglu
13
  license: apache-2.0
14
- model_type: lumees-transformer
15
  datasets:
16
  - custom-educational-corpus
17
  metrics:
@@ -25,7 +25,7 @@ widget:
25
  - text: "In the quiet library, an ancient book began to glow softly, revealing"
26
  example_title: "Fantasy Literature"
27
  model-index:
28
- - name: Lumees-362M
29
  results:
30
  - task:
31
  type: text-generation
@@ -45,11 +45,11 @@ model-index:
45
  name: PPL per Million Parameters
46
  ---
47
 
48
- # Lumees-362M
49
 
50
  ## Model Description
51
 
52
- Lumees-362M is a highly efficient 362M parameter transformer model optimized for educational content generation and creative writing. The model achieves breakthrough performance with **5.47 validation perplexity**, representing world-record efficiency in the 300M parameter class.
53
 
54
  ### Key Features
55
 
@@ -76,44 +76,50 @@ Normalization: RMS Normalization
76
  Activation: SwiGLU
77
  Dropout: 0.0
78
  Weight Tying: Yes (embedding and lm_head)
 
79
  ```
80
 
81
  ## Training Details
82
 
83
  ### Training Data
84
- - **Domain**: High quality educational content, scientific materials, creative writing
85
- - **Languages**: Primarily English with multilingual tokenizer support
86
- - **Quality**: Tier 1 exceptional quality with manual curation
 
87
 
88
  ### Training Results
89
- - **Validation PPL**: 5.47
90
- - **Training PPL**: 8.43
91
- - **Training Stability**: Excellent (gradient norm ~0.4)
 
92
 
93
  ## Performance
94
 
95
  ### Benchmarks
 
96
  | Metric | Value | Comparison |
97
- |--------|-------|------------|
98
  | Validation Perplexity | 5.47 | 4-5x better than GPT-2 Medium |
99
  | Parameters | 362M | Similar to GPT-2 Medium (355M) |
100
  | Efficiency Ratio | 0.0166 PPL/M params | High efficiency |
101
 
102
  ### Capabilities
103
- - **Educational Content**: World-class performance (targeting 3-4 PPL final)
104
- - **Creative Writing**: Beautiful narrative generation with sophisticated vocabulary
105
- - **Scientific Communication**: Excellent at explaining complex concepts
106
- - **Character Development**: Rich character interactions and dialogue
107
- - **Long-form Coherence**: Maintains coherence across extended sequences
 
108
 
109
  ## Usage
110
 
111
  ### Direct Usage
 
112
  ```python
113
  from transformers import AutoTokenizer, AutoModelForCausalLM
114
 
115
- tokenizer = AutoTokenizer.from_pretrained("lumees/lumees-362m-base")
116
- model = AutoModelForCausalLM.from_pretrained("lumees/lumees-362m-base")
117
 
118
  # Generate text
119
  inputs = tokenizer("Once upon a time, in a bustling city where dreams came alive,", return_tensors="pt")
@@ -127,9 +133,11 @@ outputs = model.generate(
127
  )
128
  generated_text = tokenizer.decode(outputs[0], skip_special_tokens=True)
129
  print(generated_text)
 
130
  ```
131
 
132
  ### Generation Parameters
 
133
  ```yaml
134
  Recommended Settings:
135
  Temperature: 0.7-0.9
@@ -137,68 +145,76 @@ Recommended Settings:
137
  Top-k: 40-60
138
  Repetition Penalty: 1.1
139
  Max Length: 200-600 tokens
 
140
  ```
141
 
142
  ## Example Generations
143
 
144
  ### Creative Storytelling
 
145
  **Prompt**: "Once upon a time, in a bustling city where dreams came alive,"
146
 
147
  **Generation**: "Once upon a time, in a bustling city where dreams came alive, there was an art gallery named 'Pink & Blue.' This quaint little store offered a diverse range of artwork from various artists and eras. Among them were two young friends - Mia, who loved exploring new styles and techniques, and Ben, passionate about capturing nature's beauty on canvas..."
148
 
149
  ### Scientific Narrative
 
150
  **Prompt**: "The scientist looked at the data in disbelief and whispered,"
151
 
152
  **Generation**: "The scientist looked at the data in disbelief and whispered, 'This shows how certain conditions can lead to undesirable outcomes.' She then asked, 'But why does that matter if something causes you to get sick?' Mr. Wise Owl explained, 'You see, when we take care of our bodies, especially those living with infectious diseases...'"
153
 
154
  ## Limitations
155
 
156
- - **Domain Focus**: Optimized for educational/creative content; may underperform on general web text
157
- - **Context Length**: Current limit of 1024 tokens (extension to 4096+ planned)
158
- - **Multilingual**: While tokenizer supports 89 languages, model primarily trained on English
159
- - **Specialized Training**: May require fine-tuning for domains outside educational/creative content
160
 
161
  ## Ethical Considerations
162
 
163
  ### Intended Use
164
- - Educational content generation
165
- - Creative writing assistance
166
- - Science communication
167
- - Research and academic applications
 
168
 
169
  ### Limitations and Biases
170
- - Training data focused on educational content may introduce domain-specific biases
171
- - Model should not be used for generating harmful, toxic, or misleading content
172
- - Outputs should be reviewed for accuracy, especially for factual claims
173
- - Not suitable for high-stakes decision making without human oversight
 
174
 
175
  ## Future Development
176
 
177
  This model serves as the foundation for a planned scaling strategy:
178
- - **724M Model**: Multilingual expansion with general knowledge
179
- - **1.4B Model**: Global language coverage with advanced capabilities
180
- - **Context Extension**: RoPE-based scaling to 4096-32768 tokens
 
181
 
182
  ## Citation
183
 
184
  If you use this model in your research, please cite:
185
 
186
  ```bibtex
187
- @misc{lumees362m2025,
188
- title={Lumees-362M: Efficient Domain-Specialized Language Model},
189
- author={Hasan KURŞUN and Kerem Berkay YANIK},
190
  year={2025},
191
  note={Achieving 5.47 PPL with 362M parameters through strategic domain specialization},
192
- url={lumees.io}
193
  }
 
194
  ```
195
 
196
  ## Model Card Authors
197
 
198
- - **Developed by**: Hasan KURŞUN, Kerem Berkay YANIK
199
- - **Model Type**: Causal Language Model
200
- - **Language**: English (primary), 89-language tokenizer support
201
- - **License**: Apache 2.0
202
- - **Contact**: hello@lumees.io
 
203
 
204
- ---
 
11
  - rmsnorm
12
  - swiglu
13
  license: apache-2.0
14
+ model_type: transformer
15
  datasets:
16
  - custom-educational-corpus
17
  metrics:
 
25
  - text: "In the quiet library, an ancient book began to glow softly, revealing"
26
  example_title: "Fantasy Literature"
27
  model-index:
28
+ - name: HK-362M
29
  results:
30
  - task:
31
  type: text-generation
 
45
  name: PPL per Million Parameters
46
  ---
47
 
48
+ # HK-362M
49
 
50
  ## Model Description
51
 
52
+ HK-362M is a highly efficient 362M parameter transformer model optimized for educational content generation and creative writing. The model achieves breakthrough performance with **5.47 validation perplexity**, representing world-record efficiency in the 300M parameter class.
53
 
54
  ### Key Features
55
 
 
76
  Activation: SwiGLU
77
  Dropout: 0.0
78
  Weight Tying: Yes (embedding and lm_head)
79
+
80
  ```
81
 
82
  ## Training Details
83
 
84
  ### Training Data
85
+
86
+ * **Domain**: High quality educational content, scientific materials, creative writing
87
+ * **Languages**: Primarily English with multilingual tokenizer support
88
+ * **Quality**: Tier 1 exceptional quality with manual curation
89
 
90
  ### Training Results
91
+
92
+ * **Validation PPL**: 5.47
93
+ * **Training PPL**: 8.43
94
+ * **Training Stability**: Excellent (gradient norm ~0.4)
95
 
96
  ## Performance
97
 
98
  ### Benchmarks
99
+
100
  | Metric | Value | Comparison |
101
+ | --- | --- | --- |
102
  | Validation Perplexity | 5.47 | 4-5x better than GPT-2 Medium |
103
  | Parameters | 362M | Similar to GPT-2 Medium (355M) |
104
  | Efficiency Ratio | 0.0166 PPL/M params | High efficiency |
105
 
106
  ### Capabilities
107
+
108
+ * **Educational Content**: World-class performance (targeting 3-4 PPL final)
109
+ * **Creative Writing**: Beautiful narrative generation with sophisticated vocabulary
110
+ * **Scientific Communication**: Excellent at explaining complex concepts
111
+ * **Character Development**: Rich character interactions and dialogue
112
+ * **Long-form Coherence**: Maintains coherence across extended sequences
113
 
114
  ## Usage
115
 
116
  ### Direct Usage
117
+
118
  ```python
119
  from transformers import AutoTokenizer, AutoModelForCausalLM
120
 
121
+ tokenizer = AutoTokenizer.from_pretrained("hasankursun/hk-362m-base")
122
+ model = AutoModelForCausalLM.from_pretrained("hasankursun/hk-362m-base")
123
 
124
  # Generate text
125
  inputs = tokenizer("Once upon a time, in a bustling city where dreams came alive,", return_tensors="pt")
 
133
  )
134
  generated_text = tokenizer.decode(outputs[0], skip_special_tokens=True)
135
  print(generated_text)
136
+
137
  ```
138
 
139
  ### Generation Parameters
140
+
141
  ```yaml
142
  Recommended Settings:
143
  Temperature: 0.7-0.9
 
145
  Top-k: 40-60
146
  Repetition Penalty: 1.1
147
  Max Length: 200-600 tokens
148
+
149
  ```
150
 
151
  ## Example Generations
152
 
153
  ### Creative Storytelling
154
+
155
  **Prompt**: "Once upon a time, in a bustling city where dreams came alive,"
156
 
157
  **Generation**: "Once upon a time, in a bustling city where dreams came alive, there was an art gallery named 'Pink & Blue.' This quaint little store offered a diverse range of artwork from various artists and eras. Among them were two young friends - Mia, who loved exploring new styles and techniques, and Ben, passionate about capturing nature's beauty on canvas..."
158
 
159
  ### Scientific Narrative
160
+
161
  **Prompt**: "The scientist looked at the data in disbelief and whispered,"
162
 
163
  **Generation**: "The scientist looked at the data in disbelief and whispered, 'This shows how certain conditions can lead to undesirable outcomes.' She then asked, 'But why does that matter if something causes you to get sick?' Mr. Wise Owl explained, 'You see, when we take care of our bodies, especially those living with infectious diseases...'"
164
 
165
  ## Limitations
166
 
167
+ * **Domain Focus**: Optimized for educational/creative content; may underperform on general web text
168
+ * **Context Length**: Current limit of 1024 tokens (extension to 4096+ planned)
169
+ * **Multilingual**: While tokenizer supports 89 languages, model primarily trained on English
170
+ * **Specialized Training**: May require fine-tuning for domains outside educational/creative content
171
 
172
  ## Ethical Considerations
173
 
174
  ### Intended Use
175
+
176
+ * Educational content generation
177
+ * Creative writing assistance
178
+ * Science communication
179
+ * Research and academic applications
180
 
181
  ### Limitations and Biases
182
+
183
+ * Training data focused on educational content may introduce domain-specific biases
184
+ * Model should not be used for generating harmful, toxic, or misleading content
185
+ * Outputs should be reviewed for accuracy, especially for factual claims
186
+ * Not suitable for high-stakes decision making without human oversight
187
 
188
  ## Future Development
189
 
190
  This model serves as the foundation for a planned scaling strategy:
191
+
192
+ * **724M Model**: Multilingual expansion with general knowledge
193
+ * **1.4B Model**: Global language coverage with advanced capabilities
194
+ * **Context Extension**: RoPE-based scaling to 4096-32768 tokens
195
 
196
  ## Citation
197
 
198
  If you use this model in your research, please cite:
199
 
200
  ```bibtex
201
+ @misc{hk362m2025,
202
+ title={HK-362M: Efficient Domain-Specialized Language Model},
203
+ author={Hasan KURŞUN},
204
  year={2025},
205
  note={Achieving 5.47 PPL with 362M parameters through strategic domain specialization},
206
+ url={[https://huggingface.co/hasankursun/hk-362m-base](https://huggingface.co/hasankursun/hk-362m-base)}
207
  }
208
+
209
  ```
210
 
211
  ## Model Card Authors
212
 
213
+ * **Developed by**: Hasan KURŞUN
214
+ * **Model Type**: Causal Language Model
215
+ * **Language**: English (primary), 89-language tokenizer support
216
+ * **License**: Apache 2.0
217
+
218
+ ```
219
 
220
+ ```