Despina commited on
Commit
52b6d28
·
verified ·
1 Parent(s): 99369f1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +146 -196
README.md CHANGED
@@ -1,207 +1,157 @@
1
  ---
 
2
  base_model: meta-llama/Llama-3.2-3B-Instruct
3
  library_name: peft
 
 
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:meta-llama/Llama-3.2-3B-Instruct
 
 
 
7
  - lora
8
- - transformers
 
 
 
 
9
  ---
10
 
11
- # Model Card for Model ID
12
-
13
- <!-- Provide a quick summary of what the model is/does. -->
14
-
15
-
16
-
17
- ## Model Details
18
-
19
- ### Model Description
20
-
21
- <!-- Provide a longer summary of what this model is. -->
22
-
23
-
24
-
25
- - **Developed by:** [More Information Needed]
26
- - **Funded by [optional]:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
-
33
- ### Model Sources [optional]
34
-
35
- <!-- Provide the basic links for the model. -->
36
-
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
40
-
41
- ## Uses
42
-
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
- ### Direct Use
46
-
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
52
-
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
-
55
- [More Information Needed]
56
-
57
- ### Out-of-Scope Use
58
-
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
-
61
- [More Information Needed]
62
-
63
- ## Bias, Risks, and Limitations
64
-
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ### Recommendations
70
-
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
-
75
- ## How to Get Started with the Model
76
-
77
- Use the code below to get started with the model.
78
-
79
- [More Information Needed]
80
-
81
- ## Training Details
82
-
83
- ### Training Data
84
-
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
-
89
- ### Training Procedure
90
-
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
-
98
- #### Training Hyperparameters
99
-
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
 
108
  ## Evaluation
109
 
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
-
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
-
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
-
182
- [More Information Needed]
183
-
184
- **APA:**
185
-
186
- [More Information Needed]
187
-
188
- ## Glossary [optional]
189
-
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Authors [optional]
199
-
200
- [More Information Needed]
201
-
202
- ## Model Card Contact
203
-
204
- [More Information Needed]
205
- ### Framework versions
206
-
207
- - PEFT 0.18.1
 
1
  ---
2
+ license: llama3.2
3
  base_model: meta-llama/Llama-3.2-3B-Instruct
4
  library_name: peft
5
+ language:
6
+ - en
7
  pipeline_tag: text-generation
8
  tags:
9
+ - relation-extraction
10
+ - information-extraction
11
+ - literary-nlp
12
+ - qlora
13
  - lora
14
+ - peft
15
+ - llama
16
+ - nlp
17
+ datasets:
18
+ - Despina/re_mixtune
19
  ---
20
 
21
+ # Llama-3.2-3B-Instruct RE MixTune (2-shot)
22
+
23
+ > Built with Llama. This is a fine-tuned derivative of Meta's Llama-3.2-3B-Instruct and is
24
+ > governed by the [Llama 3.2 Community License](https://www.llama.com/llama3_2/license/).
25
+
26
+ A 3B language model fine-tuned for **relation extraction (RE)** across **both general-domain and
27
+ literary text**. This is the best single "does-both" checkpoint from the paper *"Sub-Billion,
28
+ Super-Frontier: Fine-Tuned Small Language Models Rival Zero-Shot Frontier LLMs on General and
29
+ Literary Relation Extraction"* ([arXiv:2606.22606](https://arxiv.org/abs/2606.22606)).
30
+
31
+ Trained on a domain-balanced mixture, it handles both domains at once, scoring **0.827
32
+ general-domain average** and **0.825 literary average (positive-class micro-F1)** simultaneously —
33
+ close to each domain specialist's in-domain peak. For reference, zero-shot frontier LLMs under the
34
+ same minimal protocol reach 0.69 (GPT-5.4) and 0.66 (Claude Sonnet 4.6) on general-domain RE, and
35
+ GPT-5.4 reaches 0.578 on the two-benchmark literary average. As the paper stresses, this reflects
36
+ targeted task adaptation rather than any intrinsic superiority of small models over frontier LLMs.
37
+
38
+ It is a **QLoRA (LoRA) adapter** on top of
39
+ [`meta-llama/Llama-3.2-3B-Instruct`](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct),
40
+ tuned on the **MixTune** balanced general+literary mixture using the **2-shot** prompt style.
41
+
42
+ ## What it does
43
+
44
+ Given a sentence and two marked entities, the model outputs **only the relation label** that
45
+ holds between them (one label, no explanation). Unlike the domain specialists, this checkpoint is
46
+ meant to serve both general and literary inputs from a single model.
47
+
48
+ ## Usage
49
+
50
+ This repo is a PEFT LoRA adapter, so load the base model and attach the adapter:
51
+
52
+ ```python
53
+ import torch
54
+ from transformers import AutoModelForCausalLM, AutoTokenizer
55
+ from peft import PeftModel
56
+
57
+ BASE = "meta-llama/Llama-3.2-3B-Instruct"
58
+ ADAPTER = "Despina/Llama-3.2-3B-Instruct-re_mixtune-2-shot"
59
+
60
+ tokenizer = AutoTokenizer.from_pretrained(ADAPTER)
61
+ model = AutoModelForCausalLM.from_pretrained(BASE, torch_dtype=torch.bfloat16, device_map="auto")
62
+ model = PeftModel.from_pretrained(model, ADAPTER)
63
+ model.eval()
64
+
65
+ system_prompt = (
66
+ "You are a relation extraction system. Be concise and direct. "
67
+ "Output ONLY the relation type that holds between the two mentioned entities. "
68
+ "Do not output any explanation, punctuation, or extra text — only the label."
69
+ )
70
+ user_prompt = (
71
+ "Sentence: Steve Jobs co-founded Apple in Cupertino.\n"
72
+ "Entity 1: Steve Jobs\n"
73
+ "Entity 2: Apple\n"
74
+ "Relation:"
75
+ )
76
+
77
+ messages = [
78
+ {"role": "system", "content": system_prompt},
79
+ {"role": "user", "content": user_prompt},
80
+ ]
81
+ inputs = tokenizer.apply_chat_template(
82
+ messages, add_generation_prompt=True, return_tensors="pt"
83
+ ).to(model.device)
84
+
85
+ out = model.generate(inputs, max_new_tokens=16, do_sample=False)
86
+ print(tokenizer.decode(out[0, inputs.shape[-1]:], skip_special_tokens=True).strip())
87
+ ```
88
+
89
+ For best results, match the format the model was trained on: a system prompt asking for the
90
+ label only, and (optionally) two in-context examples before the query — this is the **2-shot**
91
+ regime. A **schema-enumerated** variant, where the allowed label set for the target dataset is
92
+ injected into the system prompt, gives the strongest results in the paper.
93
+
94
+ ## Training
95
+
96
+ | | |
97
+ |---|---|
98
+ | Base model | `meta-llama/Llama-3.2-3B-Instruct` |
99
+ | Method | QLoRA (4-bit NF4, bf16 compute, double quant) |
100
+ | LoRA | r = 64, α = 128, dropout = 0.05; targets: q/k/v/o + gate/up/down proj |
101
+ | Training data | `Despina/re_mixtune` (domain-balanced general+literary mixture), 2-shot prompts |
102
+ | Objective | Generate the relation label only |
103
+ | Epochs | 2 |
104
+ | Learning rate | 1e-4 |
105
+ | Effective batch | 4 × 2 grad-accum = 8 |
106
+ | Max sequence length | 1024 |
107
+
108
+ **MixTune** is a domain-balanced (~50/50) mixture drawing equal numbers of general and literary
109
+ examples: the seven general-domain datasets (TACRED, SemEval-2010 Task 8, CoNLL04, NYT11, GIDS,
110
+ Re-DocRED, REBEL) and the two literary datasets (Biographical, PG-Fiction).
 
 
 
 
 
 
111
 
112
  ## Evaluation
113
 
114
+ Scored with **positive-class micro-F1** (the no-relation class is excluded from the average).
115
+ Evaluated on all nine benchmarks, the model scores **0.827 general-domain average** and **0.825
116
+ literary average** simultaneously the strongest single-model choice when one model must cover
117
+ both domains. For reference, zero-shot GPT-5.4 / Claude Sonnet 4.6 reach 0.69 / 0.66 on general
118
+ RE, and GPT-5.4 reaches 0.578 on literary RE, under a minimal zero-shot protocol. As the paper
119
+ stresses, this reflects targeted task adaptation rather than any intrinsic superiority of small
120
+ models. See the paper for the full 30-configuration matrix and the RoBERTa discriminative
121
+ baseline.
122
+
123
+ ## Limitations
124
+
125
+ - Trained to emit a single relation label; it is not a general-purpose chat model.
126
+ - A single-model generalist: a domain specialist (GenTune or LitTune) may edge it out slightly
127
+ on its own domain.
128
+ - PG-Fiction labels are annotated by a GPT-4-class model, so the model partly learns that
129
+ annotator's label distribution on literary inputs.
130
+ - Inherits the biases and licensing constraints of its underlying datasets.
131
+
132
+ ## Links
133
+
134
+ - **Paper:** [arXiv:2606.22606](https://arxiv.org/abs/2606.22606)
135
+ - **Code / reproduction:** https://github.com/DespinaChristou/compact-relex
136
+ - **Training dataset:** [`Despina/re_mixtune`](https://huggingface.co/datasets/Despina/re_mixtune)
137
+
138
+ ## License
139
+
140
+ This model is a derivative of Meta Llama 3.2 and is licensed under the
141
+ [Llama 3.2 Community License](https://www.llama.com/llama3_2/license/). Use is subject to Meta's
142
+ Acceptable Use Policy. "Built with Llama."
143
+
144
+ ## Citation
145
+
146
+ If you use this model, please cite:
147
+
148
+ ```bibtex
149
+ @article{christou2026subbillion,
150
+ title = {Sub-Billion, Super-Frontier: Small Language Models Rival
151
+ Zero-Shot Frontier LLMs on General and Literary Relation Extraction},
152
+ author = {Christou, Despina and Tsoumakas, Grigorios},
153
+ journal = {arXiv preprint arXiv:2606.22606},
154
+ year = {2026},
155
+ url = {https://arxiv.org/abs/2606.22606}
156
+ }
157
+ ```