|
--- |
|
license: cc-by-nc-sa-4.0 |
|
|
|
datasets: |
|
- gtfintechlab/central_bank_of_egypt |
|
|
|
language: |
|
- en |
|
|
|
metrics: |
|
- accuracy |
|
- f1 |
|
- precision |
|
- recall |
|
|
|
base_model: |
|
- ModernBERT-base |
|
|
|
pipeline_tag: text-classification |
|
|
|
library_name: transformers |
|
--- |
|
|
|
# World of Central Banks Model |
|
|
|
**Model Name:** Central Bank of Egypt Temporal Classification Model |
|
|
|
**Model Type:** Text Classification |
|
|
|
**Language:** English |
|
|
|
**License:** [CC-BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en) |
|
|
|
**Base Model:** [ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base) |
|
|
|
**Dataset Used for Training:** [gtfintechlab/central_bank_of_egypt](https://huggingface.co/datasets/gtfintechlab/central_bank_of_egypt) |
|
|
|
## Model Overview |
|
|
|
Central Bank of Egypt Temporal Classification Model is a fine-tuned ModernBERT-base model designed to classify text data on **Temporal Classification**. This label is annotated in the central_bank_of_egypt dataset, which focuses on meeting minutes for the Central Bank of Egypt. |
|
|
|
## Intended Use |
|
|
|
This model is intended for researchers and practitioners working on subjective text classification for the Central Bank of Egypt, particularly within financial and economic contexts. It is specifically designed to assess the **Temporal Classification** label, aiding in the analysis of subjective content in financial and economic communications. |
|
|
|
## How to Use |
|
|
|
To utilize this model, load it using the Hugging Face `transformers` library: |
|
|
|
```python |
|
from transformers import pipeline, AutoTokenizer, AutoModelForSequenceClassification, AutoConfig |
|
|
|
# Load tokenizer, model, and configuration |
|
tokenizer = AutoTokenizer.from_pretrained("gtfintechlab/central_bank_of_egypt", do_lower_case=True, do_basic_tokenize=True) |
|
model = AutoModelForSequenceClassification.from_pretrained("gtfintechlab/central_bank_of_egypt", num_labels=2) |
|
config = AutoConfig.from_pretrained("gtfintechlab/central_bank_of_egypt") |
|
|
|
# Initialize text classification pipeline |
|
classifier = pipeline('text-classification', model=model, tokenizer=tokenizer, config=config, framework="pt") |
|
|
|
# Classify Temporal Classification |
|
sentences = [ |
|
"[Sentence 1]", |
|
"[Sentence 2]" |
|
] |
|
results = classifier(sentences, batch_size=128, truncation="only_first") |
|
|
|
print(results) |
|
``` |
|
|
|
In this script: |
|
|
|
- **Tokenizer and Model Loading:** |
|
Loads the pre-trained tokenizer and model from `gtfintechlab/central_bank_of_egypt`. |
|
|
|
- **Configuration:** |
|
Loads model configuration parameters, including the number of labels. |
|
|
|
- **Pipeline Initialization:** |
|
Initializes a text classification pipeline with the model, tokenizer, and configuration. |
|
|
|
- **Classification:** |
|
Labels sentences based on **Temporal Classification**. |
|
|
|
Ensure your environment has the necessary dependencies installed. |
|
|
|
## Label Interpretation |
|
|
|
- **LABEL_0:** Forward-looking; the sentence discusses future economic events or decisions. |
|
- **LABEL_1:** Not forward-looking; the sentence discusses past or current economic events or decisions. |
|
|
|
## Training Data |
|
|
|
The model was trained on the central_bank_of_egypt dataset, comprising annotated sentences from the Central Bank of Egypt meeting minutes, labeled by **Temporal Classification**. The dataset includes training, validation, and test splits. |
|
|
|
## Citation |
|
|
|
If you use this model in your research, please cite the central_bank_of_egypt: |
|
|
|
```bibtex |
|
@article{WCBShahSukhaniPardawala, |
|
title={Words That Unite The World: A Unified Framework for Deciphering Global Central Bank Communications}, |
|
author={Agam Shah, Siddhant Sukhani, Huzaifa Pardawala et al.}, |
|
year={2025} |
|
} |
|
``` |
|
|
|
For more details, refer to the [central_bank_of_egypt dataset documentation](https://huggingface.co/gtfintechlab/central_bank_of_egypt). |
|
|
|
## Contact |
|
|
|
For any central_bank_of_egypt related issues and questions, please contact: |
|
|
|
- Huzaifa Pardawala: huzaifahp7[at]gatech[dot]edu |
|
|
|
- Siddhant Sukhani: ssukhani3[at]gatech[dot]edu |
|
|
|
- Agam Shah: ashah482[at]gatech[dot]edu |
|
|