asdc
/

Qwen2.5-7B-Temporal_Relation_Extraction

PEFT

Safetensors

Model card Files Files and versions

xet

Community

asdc commited on May 10, 2025

Commit

f35c8b1

verified ·

1 Parent(s): 790a2d0

Update README.md

Browse files

Files changed (1) hide show

README.md +57 -138

README.md CHANGED Viewed

@@ -5,7 +5,7 @@ library_name: peft
 # Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
@@ -13,10 +13,6 @@ library_name: peft
 ### Model Description
-<!-- Provide a longer summary of what this model is. -->
 - **Developed by:** [More Information Needed]
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
@@ -29,144 +25,67 @@ library_name: peft
 <!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 ## 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.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[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]
-## 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]
-### Results
-[More Information Needed]
-#### 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]

 # Model Card for Model ID
+- This model has been trained for solving the temporal relation extraction task using RL over the E3C corpus as part of the paper "".
 ### Model Description
 - **Developed by:** [More Information Needed]
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
 <!-- Provide the basic links for the model. -->
+- **Repository:** https://github.com/asdc-s5/Temporal-relation-extraction-with-RL
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 ## Uses
+The model is intended to predict the temporal relation between two entities in multiple languages. The model is trained to work on Spanish, English, French, Italian and Basque but it can be used in other languages.
+### Downstream Use
+- For using the model use the following template:
+PROMPT_TEMPLATE = """
+## Instruction ##
+- Extract the start point, end point, and span for the given source and target terms.
+- Classify the relation between them using one of: BEFORE, BEGINS-ON, ENDS-ON, CONTAINS, SIMULTANEOUS, OVERLAP.
+- Answer with the XML Response Format
+## Definitions ##
+- A term has a start point (time it begins to exist), an end point (time it ceases to exist), and a span (time between both).
+## Inputs ##
+- **Context Sentence:** *"{}"*
+- **Source term:** *"{}"*
+- **Target term:** *"{}"*
+## XML Response Format ##
+<Source>
+    <Meaning>Explain the meaning of the source term</Meaning>
+    <Start>Reason about the temporal start point</Start>
+    <End>Reason about the temporal end point</End>
+    <Span>Reason about the temporal span</Span>
+</Source>
+<Target>
+    <Meaning>Explain the meaning of the target term</Meaning>
+    <Start>Reason about the temporal start point</Start>
+    <End>Reason about the temporal end point</End>
+    <Span>Reason about the temporal span</Span>
+</Target>
+<Relation>
+    <Start_Start>
+        <Reason>Reason about the relation of the start and start points</Reason>
+        <Answer>before/after/equal/different</Answer>
+    </Start_Start>
+    <Start_End>
+        <Reason>Reason about the relation of the start and end points</Reason>
+        <Answer>before/after/equal/different</Answer>
+    </Start_End>
+    <End_Start>
+        <Reason>Reason about the relation of the end and start points</Reason>
+        <Answer>before/after/equal/different</Answer>
+    </End_Start>
+    <End_End>
+        <Reason>Reason about the relation of the end and end points</Reason>
+        <Answer>before/after/equal/different</Answer>
+    </End_End>
+    <Label>BEFORE/BEGINS-ON/ENDS-ON/CONTAINS/SIMULTANEOUS/OVERLAP</Label>
+</Relation>
+<think>\n
+"""
 ## Citation [optional]