rafmacalaba commited on
Commit
ee372ff
·
verified ·
1 Parent(s): 5a41d47

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +49 -202
README.md CHANGED
@@ -1,207 +1,54 @@
1
  ---
2
- base_model: LiquidAI/LFM2.5-350M
3
- library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:LiquidAI/LFM2.5-350M
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.20.0
 
1
  ---
2
+ license: apache-2.0
 
3
  pipeline_tag: text-generation
4
  tags:
5
+ - lfm2
6
+ - data-use
7
+ - provenance
8
+ - sft
9
+ - lora
10
  ---
11
 
12
+ # lfm2.5-350M-datause-provenance
13
+
14
+ LoRA SFT of `LiquidAI/LFM2.5-350M` for data-mention provenance attribute extraction
15
+ (producer / year / geography / acronym, verbatim from context).
16
+
17
+ ## Training
18
+ - base model: `LiquidAI/LFM2.5-350M`
19
+ - dataset: `rafmacalaba/data-use-provenance-sft`
20
+ - epochs: 3
21
+ - learning rate: 0.0002
22
+ - LoRA: r=16 alpha=32 dropout=0.05
23
+ - completion-only masking (loss on assistant JSON turn)
24
+
25
+ ## Evaluation (holdout, n=3487)
26
+
27
+ Exact string match of each emitted attribute against the gold label.
28
+
29
+ | attribute | tp | fp | fn | precision | recall | f0.5 | f1 |
30
+ | --- | --- | --- | --- | --- | --- | --- | --- |
31
+ | producer | 1143 | 296 | 306 | 0.7943 | 0.7888 | 0.7932 | 0.7916 |
32
+ | year | 1085 | 207 | 265 | 0.8398 | 0.8037 | 0.8323 | 0.8213 |
33
+ | geography | 1715 | 371 | 312 | 0.8221 | 0.8461 | 0.8268 | 0.8339 |
34
+ | acronym | 1271 | 212 | 145 | 0.8570 | 0.8976 | 0.8649 | 0.8769 |
35
+ | **overall** | 5214 | 1086 | 1028 | 0.8276 | 0.8353 | 0.8291 | 0.8314 |
36
+
37
+ Verbatim rate (emitted values that are substrings of the context): 6290/6300 = 0.9984
38
+
39
+ ## Sample predictions (holdout)
40
+
41
+ | mention | target | predicted | correct | verbatim |
42
+ | --- | --- | --- | --- | --- |
43
+ | plant-level data | {"geography": "Indonesian"} | {"geography": "Indonesian"} | geography | geography |
44
+ | GIDD database | {"geography": "all regions in the world"} | {"acronym": "GIDD", "geography": "all regions in the world"} | geography | geography,acronym |
45
+ | NFHS-3 data | {"acronym": "NFHS-3", "geography": "India"} | {"acronym": "NFHS-3", "geography": "India"} | geography,acronym | geography,acronym |
46
+ | data from Hallegatte ( 2012 ) | {"year": "2012"} | {"geography": "LICs", "year": "2012"} | year | year,geography |
47
+ | national accounts | {"geography": "Turkey"} | {"geography": "Turkey"} | geography | geography |
48
+ | SRF registry of firms | {"acronym": "SRF", "geography": "Brazil", "producer": "Brazilian tax authority", "year": "2012"} | {"acronym": "SRF", "geography": "Brazil", "producer": "Brazilian tax authority", "year": "2012"} | producer,year,geography,acronym | producer,year,geography,acronym |
49
+ | Human Capital Index | {"geography": "Kenya", "producer": "World Bank", "year": "2020"} | {"geography": "Kenya", "producer": "World Bank", "year": "2020"} | producer,year,geography | producer,year,geography |
50
+ | United Nations population counts by age | {"producer": "United Nations"} | {"producer": "United Nations"} | producer | producer |
51
+ | 2002 Census | {"geography": "Rwanda", "year": "2002"} | {"geography": "Rwanda", "year": "2002"} | year,geography | year,geography |
52
+ | ENCASEH 1997 | {"acronym": "ENCASEH", "year": "1997"} | {"acronym": "ENCASEH", "year": "1997"} | year,acronym | year,acronym |
53
+ | Agricultural Wages in India | {"acronym": "AWI", "geography": "India", "producer": "Ministry of Agriculture"} | {"acronym": "AWI", "geography": "India", "producer": "Ministry of Agriculture"} | producer,geography,acronym | producer,geography,acronym |
54
+ | COVID-19 Enterprise Survey | {"geography": "Chad", "year": "2020"} | {"acronym": "ES", "geography": "Chad", "year": "2020"} | year,geography | year,geography,acronym |