Update README.md
Browse files
README.md
CHANGED
|
@@ -4,12 +4,14 @@
|
|
| 4 |
|
| 5 |
## Model Description
|
| 6 |
|
| 7 |
-
ConceptFrameMet is a
|
| 8 |
|
| 9 |
1. **Metaphor Classification**: Whether a target word is used metaphorically or literally
|
| 10 |
2. **Semantic Frames**: The conceptual frame evoked by the target word
|
| 11 |
3. **Source Domains**: The source domain of the metaphor (for metaphorical uses)
|
| 12 |
|
|
|
|
|
|
|
| 13 |
## Model Architecture
|
| 14 |
|
| 15 |
- **Base Model**: RoBERTa-base
|
|
@@ -26,10 +28,9 @@ Evaluated on standard metaphor detection benchmarks:
|
|
| 26 |
|
| 27 |
| Dataset | F1 Score | Accuracy |
|
| 28 |
|---------|----------|----------|
|
| 29 |
-
| VUA18 |
|
| 30 |
-
|
|
| 31 |
-
|
|
| 32 |
-
| TroFi | ~0.63 | ~0.67 |
|
| 33 |
|
| 34 |
## Quick Start
|
| 35 |
|
|
@@ -46,7 +47,7 @@ from transformers import RobertaTokenizer
|
|
| 46 |
import torch
|
| 47 |
|
| 48 |
# Load model and tokenizer
|
| 49 |
-
model_path = "
|
| 50 |
tokenizer = RobertaTokenizer.from_pretrained(model_path)
|
| 51 |
|
| 52 |
# Example sentence
|
|
@@ -95,22 +96,6 @@ The model returns a dictionary with:
|
|
| 95 |
- `source`: Predicted source domain (for metaphors)
|
| 96 |
- `source_confidence`: Confidence for source prediction
|
| 97 |
|
| 98 |
-
## Training Details
|
| 99 |
-
|
| 100 |
-
- **Training Dataset**: VUA18 (Visual University Amsterdam metaphor corpus)
|
| 101 |
-
- **Epochs**: 20 (with early stopping)
|
| 102 |
-
- **Batch Size**: 32
|
| 103 |
-
- **Learning Rate**: 3e-5
|
| 104 |
-
- **Optimizer**: AdamW
|
| 105 |
-
- **Seed**: 42
|
| 106 |
-
|
| 107 |
-
## Limitations
|
| 108 |
-
|
| 109 |
-
1. Performance may vary on domain-specific text
|
| 110 |
-
2. Works best on English text
|
| 111 |
-
3. Requires target word to be specified
|
| 112 |
-
4. Frame and source predictions depend on availability of auxiliary models
|
| 113 |
-
|
| 114 |
## Citation
|
| 115 |
|
| 116 |
If you use this model in your research, please cite:
|
|
@@ -124,15 +109,7 @@ If you use this model in your research, please cite:
|
|
| 124 |
}
|
| 125 |
```
|
| 126 |
|
| 127 |
-
## Related Models
|
| 128 |
-
|
| 129 |
-
- **Base Architecture**: RoBERTa (Liu et al., 2019)
|
| 130 |
-
- **MelBERT**: Choi et al., "MelBERT: Metaphor Detection via Contextualized Late Interaction"
|
| 131 |
-
- **Frame Prediction**: nixie1981/sem_frames
|
| 132 |
-
|
| 133 |
-
## License
|
| 134 |
|
| 135 |
-
[Specify your license]
|
| 136 |
|
| 137 |
## Contact
|
| 138 |
|
|
|
|
| 4 |
|
| 5 |
## Model Description
|
| 6 |
|
| 7 |
+
ConceptFrameMet is a metaphor detection model which not only detects metaphors but also predicts:
|
| 8 |
|
| 9 |
1. **Metaphor Classification**: Whether a target word is used metaphorically or literally
|
| 10 |
2. **Semantic Frames**: The conceptual frame evoked by the target word
|
| 11 |
3. **Source Domains**: The source domain of the metaphor (for metaphorical uses)
|
| 12 |
|
| 13 |
+
Please see https://github.com/julia-nixie/ConceptFrameMet and PAPER LINK for details.
|
| 14 |
+
|
| 15 |
## Model Architecture
|
| 16 |
|
| 17 |
- **Base Model**: RoBERTa-base
|
|
|
|
| 28 |
|
| 29 |
| Dataset | F1 Score | Accuracy |
|
| 30 |
|---------|----------|----------|
|
| 31 |
+
| VUA18 | 0.767 | 0.930 |
|
| 32 |
+
| MOH-X | 0.814 | 0.803 |
|
| 33 |
+
| TroFi | 0.633 | 0.605 |
|
|
|
|
| 34 |
|
| 35 |
## Quick Start
|
| 36 |
|
|
|
|
| 47 |
import torch
|
| 48 |
|
| 49 |
# Load model and tokenizer
|
| 50 |
+
model_path = "nixie1981/ConceptFrameMet"
|
| 51 |
tokenizer = RobertaTokenizer.from_pretrained(model_path)
|
| 52 |
|
| 53 |
# Example sentence
|
|
|
|
| 96 |
- `source`: Predicted source domain (for metaphors)
|
| 97 |
- `source_confidence`: Confidence for source prediction
|
| 98 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 99 |
## Citation
|
| 100 |
|
| 101 |
If you use this model in your research, please cite:
|
|
|
|
| 109 |
}
|
| 110 |
```
|
| 111 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 112 |
|
|
|
|
| 113 |
|
| 114 |
## Contact
|
| 115 |
|