Update README.md

README.md

@@ -5,25 +5,23 @@ base_model: google/gemma-7b-it
 
 # Model Card for Model ID
 
+This model provides a ready-to-go temporal expression normalization tool.
 <!-- Provide a quick summary of what the model is/does. -->
 
-
-
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
+We present a series of multilingual temporal expression normalization models. Proposed in the {paper}.
+This model has been trained over Timebank and E3C multilingual corpora with the sole objevtive of normalizing temporal expressions following the ISO TimeML schema. 
 
+A temporal expression is classified into four types: Date, Time, Duration and Set. This model predicts the value of a temporal expression. 
+For example for the expression of type duration "8 hours" the model would predict the value PT8H.
 
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** Alejandro Sánchez de Castro, Lourdes Araujo and Juan Martínez-Romo
+- **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)"
+- **Language(s) (NLP):** Multilingual
 
 ### Model Sources [optional]
 
@@ -35,168 +33,53 @@ base_model: google/gemma-7b-it
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
 ### Downstream Use [optional]
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+For using the model just follow the general PEFT guide. When using the model please use the following prompt:
 
-## How to Get Started with the Model
+  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.
 
-Use the code below to get started with the model.
+  ###Context phrase:
+  {sentence}
 
-[More Information Needed]
+  ###Temporal expression type:
+  {type}
 
-## Training Details
+  ###Temporal expression:
+  {expression}
 
-### Training Data
+  ###Reference date
+  {dct}
 
-<!-- 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. -->
+  ###Value:
 
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+The model will then return a sequence with the predicted value. It can be extracted through a simple pattern match.
 
 ## Evaluation
 
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+We compare our proposed models against current multilingual solutions as shown in the {paper}
 
 ### Results
 
-[More Information Needed]
+We managed to get an outstanding performance on over 7 languages and a promising zero-shot performance over non-trained languages.
 
 #### Summary
 
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
 ## Citation [optional]
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+To be defined
 
 **BibTeX:**
 
-[More Information Needed]
+To be defined
 
 **APA:**
 
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
+To be defined
 
 ## Model Card Contact
+[email protected]
 
-[More Information Needed]
 ### Framework versions
 
 - PEFT 0.10.1.dev0