asdc commited on
Commit
3685f71
·
verified ·
1 Parent(s): f7b77ba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -147
README.md CHANGED
@@ -5,198 +5,80 @@ base_model: meta-llama/Meta-Llama-3-8B
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
-
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]
200
  ### Framework versions
201
 
202
  - PEFT 0.10.1.dev0
 
5
 
6
  # Model Card for Model ID
7
 
8
+ This model provides a ready-to-go temporal expression normalization tool.
 
 
9
 
10
  ## Model Details
11
 
12
  ### Model Description
13
 
14
+ We present a series of multilingual temporal expression normalization models. Proposed in the {paper}.
 
 
15
 
16
+ This model has been trained over Timebank and E3C multilingual corpora with the sole objevtive of normalizing temporal expressions following the ISO TimeML schema.
 
 
 
 
 
 
17
 
18
+ A temporal expression is classified into four types: Date, Time, Duration and Set. This model predicts the value of a temporal expression.
19
+ For example for the expression of type duration "8 hours" the model would predict the value PT8H.
20
 
21
+ - **Developed by:** Alejandro Sánchez de Castro, Lourdes Araujo and Juan Martínez-Romo
22
+ - **Language(s) (NLP):** Multilingual
23
 
 
 
 
24
 
25
  ## Uses
26
 
 
 
 
 
 
 
 
 
27
  ### Downstream Use [optional]
28
 
29
+ For using the model just follow the general PEFT guide. When using the model please use the following prompt:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
31
+ Given the temporal expression type the reference date, the temporal expression and the context phrase in which the temporal expression appears, generate the value according to the TIMEX3 scheme. In the context phrase the temporal expression appears, sometimes it will be neccesary to pay attention to the surrounding context in order to resolve the expression.
32
 
33
+ ###Context phrase:
34
+ {sentence}
35
 
36
+ ###Temporal expression type:
37
+ {type}
38
 
39
+ ###Temporal expression:
40
+ {expression}
41
 
42
+ ###Reference date
43
+ {dct}
44
 
45
+ ###Value:
46
 
47
+ The model will then return a sequence with the predicted value. It can be extracted through a simple pattern match.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
48
 
49
  ## Evaluation
50
 
51
+ We compare our proposed models against current multilingual solutions as shown in the {paper}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
 
53
  ### Results
54
 
55
+ We managed to get an outstanding performance on over 7 languages and a promising zero-shot performance over non-trained languages.
56
 
57
  #### Summary
58
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
  ## Citation [optional]
60
 
61
+ To be defined
62
 
63
  **BibTeX:**
64
 
65
+ To be defined
66
 
67
  **APA:**
68
 
69
+ To be defined
 
 
70
 
71
+ ### Acklowledge:
72
+ - **Funded by:** funded by the following projects DOTT-HEALTH (MCI/AEI/FEDER, UE with identification PID2019-106942RB-C32), OBSER-MENH (MCIN/AEI/10.13039/501100011033 and NextGenerationEU”/PRTR with identification TED2021-130398B-C21), SICAMESP (with identification 2023-VICE-0029) and by the project EDHER-MED (with identification PID2022-136522OB-C21)"
73
 
 
74
 
75
+ ### Model Sources [optional]
 
 
 
 
76
 
77
+ - **Paper:** To be defined
78
 
79
  ## Model Card Contact
80
+ asanchez@lsi.uned.es
81
 
 
82
  ### Framework versions
83
 
84
  - PEFT 0.10.1.dev0