ambrosfitz commited on
Commit
740646e
Β·
verified Β·
1 Parent(s): f1baf7c

Add detailed model card

Browse files
Files changed (1) hide show
  1. README.md +135 -167
README.md CHANGED
@@ -1,199 +1,167 @@
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
+ base_model: HuggingFaceTB/SmolLM2-360M
4
+ datasets:
5
+ - ambrosfitz/Wikipedia_GraphCoT_Summarization
6
+ language:
7
+ - en
8
+ tags:
9
+ - text-generation
10
+ - summarization
11
+ - chain-of-thought
12
+ - graph-reasoning
13
+ - fine-tuned
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ # SmolLM2-360M β€” GraphCoT Fine-tune
18
 
19
+ Fine-tuned version of [SmolLM2-360M](https://huggingface.co/HuggingFaceTB/SmolLM2-360M) on the [Wikipedia GraphCoT Summarization](https://huggingface.co/datasets/ambrosfitz/Wikipedia_GraphCoT_Summarization) dataset.
20
 
21
+ The model learns to perform **semantic graph chain-of-thought (GraphCoT) summarization**: given a raw paragraph, it explicitly constructs a semantic knowledge graph before writing a summary grounded exclusively in that graph. No fact in the summary can appear unless it exists as an edge.
22
 
23
+ ---
24
 
25
+ ## What it does
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
 
27
+ Given a paragraph wrapped in `<input>` tags, the model generates a structured `<reasoning>` block followed by a `<summary>`:
 
 
 
 
28
 
29
+ 1. **Content words** β€” extracts key nouns, verbs, and proper entities
30
+ 2. **Coreference** β€” resolves pronouns and aliases to a single primary subject
31
+ 3. **Relations** β€” builds `(subject, relation, object)` triples in snake_case
32
+ 4. **Graph** β€” organises triples into a rooted ASCII tree
33
+ 5. **Summary** β€” writes 1–3 sentences where every clause maps to a graph edge
34
 
35
+ ---
36
 
37
+ ## Example output
38
+
39
+ **Input:**
40
+ ```
41
+ Alan Turing was a British mathematician and computer scientist who played a
42
+ crucial role in breaking German ciphers during World War II. He is widely
43
+ regarded as the father of theoretical computer science and artificial intelligence.
44
+ ```
45
+
46
+ **Model output:**
47
+ ```
48
+ <reasoning>
49
+ <content_words>
50
+ nouns: mathematician, computer, scientist, role, cipher, father, theory, intelligence
51
+ verbs: break, regard
52
+ proper_entities: Alan Turing, British, World War II, German
53
+ </content_words>
54
+
55
+ <coref>
56
+ (none)
57
+ </coref>
58
+
59
+ <relations>
60
+ (Alan Turing, is_a, British mathematician)
61
+ (Alan Turing, is_a, computer scientist)
62
+ (Alan Turing, broke, German ciphers)
63
+ (Alan Turing, broke_during, World War II)
64
+ (Alan Turing, is_the_father_of, theoretical computer science)
65
+ (Alan Turing, is_the_father_of, artificial intelligence)
66
+ </relations>
67
+
68
+ <graph>
69
+ ROOT: Alan Turing
70
+ β”œβ”€ is_a -> British mathematician
71
+ β”œβ”€ is_a -> computer scientist
72
+ β”œβ”€ broke -> German ciphers
73
+ β”‚ └─ broke_during -> World War II
74
+ β”œβ”€ is_the_father_of -> theoretical computer science
75
+ └─ is_the_father_of -> artificial intelligence
76
+ </graph>
77
+ </reasoning>
78
+
79
+ <summary>
80
+ Alan Turing was a British mathematician and computer scientist who broke German
81
+ ciphers during World War II. He is regarded as the father of theoretical computer
82
+ science and artificial intelligence.
83
+ </summary>
84
+ ```
85
 
86
+ ---
87
 
88
+ ## Usage
89
 
90
+ ```python
91
+ from transformers import AutoTokenizer, AutoModelForCausalLM
92
+ import torch
93
 
94
+ model_id = "ambrosfitz/smollm2-graphcot"
95
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
96
+ model = AutoModelForCausalLM.from_pretrained(model_id, torch_dtype=torch.float16, device_map="auto")
97
 
98
+ paragraph = "Your paragraph here."
99
+ prompt = f"<input>\n{paragraph}\n</input>\n\n<reasoning>\n"
100
 
101
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
102
+ with torch.no_grad():
103
+ output_ids = model.generate(
104
+ **inputs,
105
+ max_new_tokens=400,
106
+ do_sample=False,
107
+ repetition_penalty=1.1,
108
+ )
109
 
110
+ print(tokenizer.decode(output_ids[0][inputs["input_ids"].shape[1]:], skip_special_tokens=True))
111
+ ```
112
 
113
+ ---
114
 
115
+ ## Training
116
 
117
+ ### Dataset
118
+ [ambrosfitz/Wikipedia_GraphCoT_Summarization](https://huggingface.co/datasets/ambrosfitz/Wikipedia_GraphCoT_Summarization) β€” 6,856 Wikipedia paragraphs processed through a two-stage pipeline:
119
 
120
+ - **Stage 1 (local):** spaCy scaffold β€” content word extraction, dependency triples, coreference clustering
121
+ - **Stage 2 (LLM):** Gemini 2.5 Flash normalization β€” semantic edge labelling, tree assembly, grounded summary generation
122
 
123
+ | Split | Records |
124
+ |-------|---------|
125
+ | Train | 6,172 |
126
+ | Validation | 342 |
127
+ | Test | 342 |
128
 
129
+ ### Loss masking
130
+ Only `<reasoning>` and `<summary>` tokens contribute to the loss. The `<input>` paragraph is masked (`label = -100`) so the model learns to *generate* the graph and summary, not memorise the input.
131
 
132
+ ### Hyperparameters
133
 
134
+ | Parameter | Value |
135
+ |-----------|-------|
136
+ | Base model | HuggingFaceTB/SmolLM2-360M |
137
+ | Epochs | 3 |
138
+ | Effective batch size | 16 (8 Γ— 2 grad accum) |
139
+ | Learning rate | 2e-5 |
140
+ | LR schedule | Cosine with 100 warmup steps |
141
+ | Max sequence length | 1024 tokens |
142
+ | Precision | fp16 (AMP) |
143
+ | Gradient checkpointing | Yes |
144
+ | Hardware | NVIDIA T4 (Google Colab) |
145
+ | Training time | ~2h 18m |
146
 
147
+ ### Training curves
148
 
149
+ | Step | Train Loss | Eval Loss |
150
+ |------|-----------|-----------|
151
+ | 100 | 0.520 | 0.497 |
152
+ | 300 | 0.369 | 0.367 |
153
+ | 500 | 0.315 | 0.335 |
154
+ | 700 | 0.310 | 0.320 |
155
+ | 900 | 0.260 | 0.314 |
156
+ | 1100 | 0.278 | 0.312 |
157
+ | 1158 | 0.282 | 0.312 |
158
 
159
+ Train and validation loss stayed within ~0.03 throughout β€” no overfitting.
160
 
161
+ ---
162
 
163
+ ## Limitations
164
 
165
+ - Trained on Wikipedia-style encyclopaedic paragraphs; may produce lower-quality graphs on conversational or highly technical text
166
+ - 360M parameters β€” graph structure may be incomplete or inconsistent on long or complex inputs
167
+ - Max context 1024 tokens; paragraphs longer than ~700 words will be truncated