Publish validated UltraFinBERT-150M FP16 weights, model card and evaluation

NOTICE.md

@@ -0,0 +1,9 @@
+# Attribution and licensing
+
+Base model and inherited custom implementation: dmis-lab/UltraBERT-150M, Apache-2.0.
+Source revision: 4cc8ca415eb1958184c491297fe5aaa94c4a8ad2. https://huggingface.co/dmis-lab/UltraBERT-150M
+
+Fine-tuned weights: CC BY-NC-SA 3.0.
+Training data: FinancialPhraseBank, Malo et al. (2014), CC BY-NC-SA 3.0.
+https://creativecommons.org/licenses/by-nc-sa/3.0/
+https://www.apache.org/licenses/LICENSE-2.0

ProsusAI__finbert_classification_report.json

@@ -0,0 +1,33 @@
+{
+  "negative": {
+    "precision": 0.9574468085106383,
+    "recall": 0.9782608695652174,
+    "f1-score": 0.967741935483871,
+    "support": 46.0
+  },
+  "neutral": {
+    "precision": 1.0,
+    "recall": 0.9759615384615384,
+    "f1-score": 0.9878345498783455,
+    "support": 208.0
+  },
+  "positive": {
+    "precision": 0.9550561797752809,
+    "recall": 1.0,
+    "f1-score": 0.9770114942528736,
+    "support": 85.0
+  },
+  "accuracy": 0.9823008849557522,
+  "macro avg": {
+    "precision": 0.9708343294286398,
+    "recall": 0.9847408026755854,
+    "f1-score": 0.9775293265383634,
+    "support": 339.0
+  },
+  "weighted avg": {
+    "precision": 0.9829567211574874,
+    "recall": 0.9823008849557522,
+    "f1-score": 0.9823943729157764,
+    "support": 339.0
+  }
+}

README.md

@@ -0,0 +1,226 @@
+---
+language:
+- en
+license: cc-by-nc-sa-3.0
+library_name: transformers
+pipeline_tag: text-classification
+base_model: dmis-lab/UltraBERT-150M
+base_model_relation: finetune
+datasets:
+- takala/financial_phrasebank
+tags:
+- finance
+- sentiment-analysis
+- financial-sentiment-analysis
+- ultrabert
+- custom_code
+- fp16
+metrics:
+- accuracy
+- f1
+model-index:
+- name: UltraFinBERT-150M
+  results:
+  - task:
+      type: text-classification
+      name: Financial sentiment classification
+    dataset:
+      type: takala/financial_phrasebank
+      name: FinancialPhraseBank AllAgree (provided held-out test split)
+      config: sentences_allagree
+      split: test
+    metrics:
+    - type: accuracy
+      name: Accuracy
+      value: 0.96460177
+    - type: f1
+      name: Macro F1
+      value: 0.96159049
+---
+
+# UltraFinBERT-150M
+
+**UltraFinBERT-150M** is an English financial sentiment classifier obtained by
+full fine-tuning [dmis-lab/UltraBERT-150M](https://huggingface.co/dmis-lab/UltraBERT-150M) on the
+unanimous-annotation subset of **FinancialPhraseBank**. It predicts the financial
+polarity of a sentence from an investor-oriented perspective: **negative**,
+**neutral**, or **positive**. The model has 151,034,883 parameters and is
+distributed as **FP16 Safetensors weights**, with the tokenizer and custom
+UltraBERT implementation required for loading.
+
+## Model details
+
+- Base checkpoint revision: `4cc8ca415eb1958184c491297fe5aaa94c4a8ad2`.
+- Architecture: UltraBERT encoder with a three-class sequence classification head.
+- Training method: full parameter fine-tuning; standard three-class cross-entropy.
+- Label mapping: `0 = negative`, `1 = neutral`, `2 = positive`.
+- Fine-tuning and evaluation maximum input length: **256 tokens**.
+- The upstream encoder supports longer context, but this classifier was trained
+  and evaluated on short sentences; long-document performance was not evaluated.
+- Custom code: required (`trust_remote_code=True`).
+
+## Training data and split
+
+The source is the provided FinancialPhraseBank AllAgree data. Input source:
+**provided TXT file**. Encoding: `cp1252`. Source SHA-256
+fingerprint(s): `5fb370b3005b9a2759f708849a691ad2e4d2593d4c995c1afde229398a516594`. The optional TXT fallback is parsed
+at the last `@` separator on each non-empty line.
+
+- Original examples: **2264**.
+- Duplicate rows removed after NFKC, whitespace and case normalization:
+  **5**.
+- Contradictory-label rows excluded: **0**.
+- Retained examples: **2259**.
+- Split method: **Stratified 70/15/15 split generated from TXT with seed 42 (fallback mode)**.
+- Partition sizes: **1581 train / 339 validation /
+  339 test**.
+
+Text is preserved in its original form after outer whitespace trimming.
+Normalized exact duplicates cannot cross the three splits. Semantic or
+article-level duplicates are not identified; no article identifiers are supplied.
+The test split is held out from this fine-tuning run. Exposure during upstream
+pretraining has not been audited. This is a custom split, not an official
+FinancialPhraseBank test partition. The split manifest contains hashes and labels,
+not the raw sentences.
+
+## Fine-tuning procedure
+
+- AdamW: beta1 **0.9**, beta2 **0.98**, epsilon **1e-6**.
+- Weight decay: **0.1**, using Trainer's standard decay parameter grouping.
+- Linear learning-rate decay, **5% warm-up**, rounded up to a full optimizer step.
+- Learning-rate search: **5e-6, 8e-6, 1e-5, 3e-5, 5e-5, 8e-5**.
+- Selected learning rate: **8e-06**.
+- Maximum epochs: **10**; early stopping patience: **3** validation checks.
+- Per-device batch: **8**; gradient accumulation: **4**;
+  effective batch: **32** on one GPU/process.
+- Gradient clipping: **1.0**; gradient checkpointing enabled; attention: **SDPA**.
+- Training compute precision: **bfloat16**, with FP32 trainable parameters.
+- Export precision: **FP16**. Evaluation compute precision: **torch.float16**.
+- Selection: maximum validation macro F1; validation loss breaks ties across trials.
+  Each trial restores its best validation checkpoint. No final refit on the test
+  or validation split is performed. The exported weights are evaluated directly.
+- One training seed is used. Training-seed variability has not been measured.
+
+### Learning-rate search (validation only)
+
+|   learning_rate |   validation_macro_f1 |   validation_accuracy |   trained_epochs |
+|----------------:|----------------------:|----------------------:|-----------------:|
+|           8e-06 |              0.988832 |                0.9941 |                8 |
+
+Post-export validation macro F1: **0.9888**.
+Change from the restored pre-export checkpoint's validation macro F1:
+**+0.000000**; compute precision also differs.
+
+## Evaluation and checkpoint comparison
+
+All three checkpoints are evaluated on exactly the same local test sentences,
+with their own tokenizer, right padding, the same 256-token truncation cap,
+and probabilities aligned by the label names in each model's configuration.
+Reference checkpoints are evaluated as published, without additional fine-tuning.
+The reference revisions are recorded in `experiment.json` and `test_comparison.json`.
+
+| model                             |   accuracy |   macro_f1 |   weighted_f1 |   macro_f1_ci95_low |   macro_f1_ci95_high |
+|:----------------------------------|-----------:|-----------:|--------------:|--------------------:|---------------------:|
+| beethogedeon/UltraFinBERT-150M    |     0.9646 |     0.9616 |        0.9642 |              0.9373 |               0.9815 |
+| ProsusAI/finbert                  |     0.9823 |     0.9775 |        0.9824 |              0.9591 |               0.9945 |
+| beethogedeon/Modern-FinBERT-large |     0.9823 |     0.9749 |        0.9821 |              0.9526 |               0.9916 |
+
+**Comparison caveat:** both `ProsusAI/finbert` and
+`beethogedeon/Modern-FinBERT-large` report fine-tuning on FinancialPhraseBank.
+Their original training partitions are not verified against this test, so overlap
+is possible. These scores are a descriptive checkpoint comparison, not a
+contamination-controlled ranking or evidence of superiority on unseen data.
+Use an independently collected external test corpus for stronger conclusions.
+
+Confidence intervals are 95% percentile intervals from **2000**
+class-stratified bootstrap resamples of the held-out test predictions.
+They describe test-sampling uncertainty, not variation across training seeds.
+Per-class reports, log-loss, balanced accuracy, truncation rates and confusion
+matrices are provided in the repository.
+
+![Confusion matrices](confusion_matrices.png)
+
+![Macro F1 comparison](macro_f1_comparison.png)
+
+## Usage
+
+Install the Transformers version used in this experiment:
+
+```bash
+pip install transformers==5.16.1 'torch>=2.6' safetensors
+```
+
+```python
+import torch
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+
+model_id = "beethogedeon/UltraFinBERT-150M"
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+dtype = torch.float16 if device.type == "cuda" else torch.float32
+tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
+tokenizer.padding_side = "right"
+model = AutoModelForSequenceClassification.from_pretrained(
+    model_id,
+    trust_remote_code=True,
+    dtype=dtype,
+    attn_implementation="sdpa",
+).to(device).eval()
+
+texts = ["Operating profit increased compared with the previous year."]
+inputs = tokenizer(texts, padding=True, truncation=True,
+                   max_length=256, return_tensors="pt").to(device)
+with torch.inference_mode():
+    probabilities = model(**inputs).logits.float().softmax(dim=-1)
+for row in probabilities.cpu():
+    print(dict(zip([model.config.id2label[i] for i in range(3)], row.tolist())))
+```
+
+For reproducible deployment, pin `revision` to a specific commit from this
+repository. Loading custom code executes repository Python code; review it first.
+CPU inference casts the stored FP16 weights to FP32. This does not change the
+FP16 format of the distributed checkpoint.
+
+## Intended uses and limitations
+
+Intended for research and non-commercial financial sentence sentiment analysis
+consistent with the applicable license. This model estimates textual sentiment;
+it is not a trading signal, a forecast, or financial advice.
+
+The dataset is small and imbalanced, concentrated in English financial news and
+the Finnish listed-company context. Unanimously annotated examples may be easier
+than ambiguous real-world news. Performance on other markets, current events,
+sarcasm, multilingual inputs and long documents is not established. Softmax
+probabilities are not calibrated confidence guarantees. Evaluate on representative
+data before using the model in a downstream application.
+
+## Reproducibility
+
+See `experiment.json`, `requirements.txt`, `data_audit.json`, `split_manifest.csv`,
+`selection.json`, `learning_rate_search.csv`, `fp16_validation.json`,
+`test_comparison.json`, and the classification reports. The original text corpus,
+optimizer state, authentication secrets and text-level prediction logs are not
+included in this model repository.
+
+## License and attribution
+
+The original UltraBERT checkpoint is published under **Apache-2.0**. FinancialPhraseBank
+is distributed under **Creative Commons Attribution-NonCommercial-ShareAlike 3.0
+Unported** ([dataset card](https://huggingface.co/datasets/takala/financial_phrasebank),
+[license](https://creativecommons.org/licenses/by-nc-sa/3.0/)). The fine-tuned weights
+in this repository are released under **CC BY-NC-SA 3.0**. Upstream code retains
+its original licensing and attribution. Commercial use requires appropriate rights
+for the data and any other applicable components. No license is inferred from the
+licenses of the reference models.
+
+Please credit the authors of UltraBERT and FinancialPhraseBank:
+
+- Jungwoo Park, Taewhoo Lee and Jaewoo Kang. *UltraBERT: Beyond the Limit of BERT
+  Pre-Training* (2026). https://arxiv.org/abs/2610.15028
+- Pekka Malo, Ankur Sinha, Pekka Korhonen, Jyrki Wallenius and Pyry Takala.
+  *Good debt or bad debt: Detecting semantic orientations in economic texts*.
+  Journal of the Association for Information Science and Technology (2014).
+  https://arxiv.org/abs/1307.5336
+
+Reference model cards:
+[ProsusAI/finbert](https://huggingface.co/ProsusAI/finbert) and
+[beethogedeon/Modern-FinBERT-large](https://huggingface.co/beethogedeon/Modern-FinBERT-large).

beethogedeon__Modern-FinBERT-large_classification_report.json

@@ -0,0 +1,33 @@
+{
+  "negative": {
+    "precision": 0.9387755102040817,
+    "recall": 1.0,
+    "f1-score": 0.968421052631579,
+    "support": 46.0
+  },
+  "neutral": {
+    "precision": 0.985781990521327,
+    "recall": 1.0,
+    "f1-score": 0.9928400954653938,
+    "support": 208.0
+  },
+  "positive": {
+    "precision": 1.0,
+    "recall": 0.9294117647058824,
+    "f1-score": 0.9634146341463414,
+    "support": 85.0
+  },
+  "accuracy": 0.9823008849557522,
+  "macro avg": {
+    "precision": 0.9748525002418029,
+    "recall": 0.9764705882352942,
+    "f1-score": 0.9748919274144381,
+    "support": 339.0
+  },
+  "weighted avg": {
+    "precision": 0.9829685176926956,
+    "recall": 0.9823008849557522,
+    "f1-score": 0.9821485315052908,
+    "support": 339.0
+  }
+}

beethogedeon__UltraFinBERT-150M_classification_report.json

@@ -0,0 +1,33 @@
+{
+  "negative": {
+    "precision": 0.9782608695652174,
+    "recall": 0.9782608695652174,
+    "f1-score": 0.9782608695652174,
+    "support": 46.0
+  },
+  "neutral": {
+    "precision": 0.958139534883721,
+    "recall": 0.9903846153846154,
+    "f1-score": 0.9739952718676123,
+    "support": 208.0
+  },
+  "positive": {
+    "precision": 0.9743589743589743,
+    "recall": 0.8941176470588236,
+    "f1-score": 0.9325153374233128,
+    "support": 85.0
+  },
+  "accuracy": 0.9646017699115044,
+  "macro avg": {
+    "precision": 0.9702531262693043,
+    "recall": 0.9542543773362188,
+    "f1-score": 0.9615904929520475,
+    "support": 339.0
+  },
+  "weighted avg": {
+    "precision": 0.9649366845909345,
+    "recall": 0.9646017699115044,
+    "f1-score": 0.9641735110013125,
+    "support": 339.0
+  }
+}

config.json

@@ -0,0 +1,96 @@
+{
+  "architectures": [
+    "UltrabertForSequenceClassification"
+  ],
+  "attention_bias": false,
+  "attention_dropout": 0.0,
+  "attention_windows": [
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null,
+    128,
+    128,
+    null
+  ],
+  "auto_map": {
+    "AutoConfig": "configuration_ultrabert.UltrabertConfig",
+    "AutoModelForSequenceClassification": "modeling_ultrabert.UltrabertForSequenceClassification"
+  },
+  "bos_token_id": 0,
+  "classifier_dropout": 0.0,
+  "dtype": "float16",
+  "eos_token_id": 0,
+  "fine_tuning_max_length": 256,
+  "finetuning_task": "financial-sentiment-analysis",
+  "head_dim": 128,
+  "hidden_act": "silu",
+  "hidden_size": 768,
+  "id2label": {
+    "0": "negative",
+    "1": "neutral",
+    "2": "positive"
+  },
+  "initializer_range": 0.02,
+  "intermediate_size": 1024,
+  "label2id": {
+    "negative": 0,
+    "neutral": 1,
+    "positive": 2
+  },
+  "mlp_bias": false,
+  "model_type": "ultrabert",
+  "num_attention_heads": 6,
+  "num_hidden_layers": 24,
+  "num_key_value_heads": 6,
+  "pad_token_id": 0,
+  "prediction_head_size": 768,
+  "problem_type": "single_label_classification",
+  "rms_norm_eps": 1e-06,
+  "rope_theta": [
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0,
+    10000.0,
+    10000.0,
+    2560000.0
+  ],
+  "tie_word_embeddings": false,
+  "transformers_version": "5.16.1",
+  "vocab_size": 49152
+}

configuration_ultrabert.py

@@ -0,0 +1,67 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+from transformers.configuration_utils import PretrainedConfig
+
+
+class UltrabertConfig(PretrainedConfig):
+    model_type = "ultrabert"
+
+    def __init__(
+        self,
+        vocab_size=32000,
+        hidden_size=4096,
+        intermediate_size=11008,
+        prediction_head_size=None,
+        num_hidden_layers=32,
+        num_attention_heads=32,
+        num_key_value_heads=None,
+        attention_windows=None,
+        hidden_act="silu",
+        initializer_range=0.02,
+        rms_norm_eps=1e-6,
+        pad_token_id=0,
+        bos_token_id=0,
+        eos_token_id=0,
+        tie_word_embeddings=False,
+        rope_theta=10000.0,
+        attention_bias=False,
+        attention_dropout=0.0,
+        mlp_bias=False,
+        head_dim=None,
+        classifier_dropout=0.0,
+        **kwargs,
+    ):
+        super().__init__(
+            pad_token_id=pad_token_id,
+            bos_token_id=bos_token_id,
+            eos_token_id=eos_token_id,
+            tie_word_embeddings=tie_word_embeddings,
+            **kwargs,
+        )
+        self.vocab_size = vocab_size
+        self.hidden_size = hidden_size
+        self.intermediate_size = intermediate_size
+        self.prediction_head_size = prediction_head_size
+        self.num_hidden_layers = num_hidden_layers
+        self.num_attention_heads = num_attention_heads
+        self.num_key_value_heads = num_key_value_heads or num_attention_heads
+        self.attention_windows = (
+            attention_windows
+            if isinstance(attention_windows, Iterable)
+            else [attention_windows] * num_hidden_layers
+        )
+        self.hidden_act = hidden_act
+        self.initializer_range = initializer_range
+        self.rms_norm_eps = rms_norm_eps
+        self.rope_theta = (
+            rope_theta
+            if isinstance(rope_theta, Iterable)
+            else [rope_theta] * num_hidden_layers
+        )
+        self.attention_bias = attention_bias
+        self.attention_dropout = attention_dropout
+        self.mlp_bias = mlp_bias
+        self.head_dim = head_dim or self.hidden_size // self.num_attention_heads
+        self.classifier_dropout = classifier_dropout

data_audit.json

@@ -0,0 +1,26 @@
+{
+  "raw_rows": 2264,
+  "encoding": "cp1252",
+  "conflict_groups": 0,
+  "conflict_rows_removed": 0,
+  "duplicate_rows_removed": 5,
+  "retained_rows": 2259,
+  "raw_label_counts": {
+    "neutral": 1391,
+    "positive": 570,
+    "negative": 303
+  },
+  "retained_label_counts": {
+    "neutral": 1386,
+    "positive": 570,
+    "negative": 303
+  },
+  "source_sha256": "5fb370b3005b9a2759f708849a691ad2e4d2593d4c995c1afde229398a516594",
+  "source": "provided TXT file",
+  "split_strategy_note": "Stratified 70/15/15 split generated from TXT with seed 42 (fallback mode)",
+  "split_sizes": {
+    "train": 1581,
+    "validation": 339,
+    "test": 339
+  }
+}

experiment.json

@@ -0,0 +1,76 @@
+{
+  "base_model": "dmis-lab/UltraBERT-150M",
+  "hub_repo_id": "beethogedeon/UltraFinBERT-150M",
+  "model_revisions": {
+    "dmis-lab/UltraBERT-150M": "4cc8ca415eb1958184c491297fe5aaa94c4a8ad2",
+    "ProsusAI/finbert": "0bc2ac10dda6929bcb1f77ccc43c7ec5c424f031",
+    "beethogedeon/Modern-FinBERT-large": "a5dd04dae984a46e729698ca39f398181c9aaeea"
+  },
+  "seed": 42,
+  "label2id": {
+    "negative": 0,
+    "neutral": 1,
+    "positive": 2
+  },
+  "max_length": 256,
+  "split_strategy": "Stratified 70/15/15 split generated from TXT with seed 42 (fallback mode)",
+  "learning_rates": [
+    8e-06
+  ],
+  "max_epochs": 10,
+  "early_stopping_patience": 3,
+  "train_batch_size": 8,
+  "gradient_accumulation_steps": 4,
+  "effective_batch_size": 32,
+  "optimizer": "AdamW",
+  "betas": [
+    0.9,
+    0.98
+  ],
+  "epsilon": 1e-06,
+  "weight_decay": 0.1,
+  "scheduler": "linear",
+  "warmup_fraction": 0.05,
+  "training_compute_dtype": "bfloat16",
+  "evaluation_compute_dtype": "torch.float16",
+  "export_dtype": "float16",
+  "attention": "sdpa",
+  "data_audit": {
+    "raw_rows": 2264,
+    "encoding": "cp1252",
+    "conflict_groups": 0,
+    "conflict_rows_removed": 0,
+    "duplicate_rows_removed": 5,
+    "retained_rows": 2259,
+    "raw_label_counts": {
+      "neutral": 1391,
+      "positive": 570,
+      "negative": 303
+    },
+    "retained_label_counts": {
+      "neutral": 1386,
+      "positive": 570,
+      "negative": 303
+    },
+    "source_sha256": "5fb370b3005b9a2759f708849a691ad2e4d2593d4c995c1afde229398a516594",
+    "source": "provided TXT file",
+    "split_strategy_note": "Stratified 70/15/15 split generated from TXT with seed 42 (fallback mode)",
+    "split_sizes": {
+      "train": 1581,
+      "validation": 339,
+      "test": 339
+    }
+  },
+  "environment": {
+    "torch": "2.11.0+cu128",
+    "transformers": "5.16.1",
+    "accelerate": "1.14.0",
+    "datasets": "4.8.5",
+    "huggingface_hub": "1.29.0",
+    "safetensors": "0.8.0",
+    "numpy": "2.1.3",
+    "pandas": "2.3.3",
+    "scikit-learn": "1.6.1"
+  },
+  "device": "Tesla T4"
+}

fp16_validation.json

@@ -0,0 +1,12 @@
+{
+  "accuracy": 0.9941002949852508,
+  "balanced_accuracy": 0.9922480620155039,
+  "macro_f1": 0.9888320545609548,
+  "weighted_f1": 0.9941297180665263,
+  "macro_precision": 0.9858156028368795,
+  "macro_recall": 0.9922480620155039,
+  "log_loss": 0.048102747473030165,
+  "pre_export_validation_macro_f1": 0.9888320545609548,
+  "macro_f1_delta_after_export": 0.0,
+  "truncation_rate": 0.0
+}

learning_rate_search.csv

@@ -0,0 +1,2 @@
+learning_rate,validation_macro_f1,validation_accuracy,validation_loss,trained_epochs,best_checkpoint,global_steps,warmup_steps,training_seconds
+8e-06,0.9888320545609548,0.9941002949852508,0.04801607131958008,8.0,ultrafinbert_runs/20261016T154623284896Z/trials/lr_8e-06/checkpoint-250,400,25,450.235867831

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8c6d414057f5f509b4e04b6990ffbdfc1d1852a264f892df26e9e7a874ea4839
+size 302095062

modeling_ultrabert.py

@@ -0,0 +1,766 @@
+#                🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+#           This file was automatically generated from examples/modular_ultrabert.py.
+#               Do NOT edit this file manually as any edits will be overwritten by the generation of
+#             the file from the modular. If any change should be done, please apply the change to the
+#                          modular_ultrabert.py file directly. One of our CI enforces this.
+#                🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+from collections.abc import Callable
+
+import torch
+from torch import nn
+from torch.nn import BCEWithLogitsLoss, CrossEntropyLoss, MSELoss
+from transformers.activations import ACT2FN
+from transformers.modeling_outputs import (
+    BaseModelOutput,
+    MaskedLMOutput,
+    QuestionAnsweringModelOutput,
+    SequenceClassifierOutput,
+    TokenClassifierOutput,
+)
+from transformers.modeling_utils import PreTrainedModel
+from transformers.processing_utils import Unpack
+from transformers.utils import TransformersKwargs, auto_docstring, can_return_tuple
+from transformers.utils.generic import merge_with_config_defaults
+from transformers.utils.output_capturing import capture_outputs
+
+from transformers.cache_utils import Cache
+from transformers.integrations import use_kernel_forward_from_hub, use_kernelized_func
+from transformers.modeling_layers import GradientCheckpointingLayer
+from transformers.modeling_rope_utils import dynamic_rope_update
+from transformers.modeling_utils import ALL_ATTENTION_FUNCTIONS
+from transformers.utils.deprecation import deprecate_kwarg
+from transformers.utils.generic import maybe_autocast
+from .configuration_ultrabert import UltrabertConfig
+
+
+class RotaryEmbedding(nn.Module):
+    @deprecate_kwarg("device", version="5.18")
+    def __init__(self, base: float, dim: int, device: torch.device | None = None):
+        super().__init__()
+        self.rope_type = "default"
+        self.attention_scaling = 1
+        self.base, self.dim = base, dim
+
+        inv_freq = torch.arange(0, dim, 2, dtype=torch.int64)
+        inv_freq = 1.0 / (base ** (inv_freq.to(device=device, dtype=torch.float) / dim))
+        self.register_buffer("inv_freq", inv_freq, persistent=False)
+
+    @staticmethod
+    @deprecate_kwarg("device", version="5.18")
+    def compute_default_rope_parameters(
+        config: UltrabertConfig, device=None, **kwargs
+    ) -> tuple[torch.Tensor, float]:
+        """
+        Computes the inverse frequencies according to the original RoPE implementation
+        Args:
+            config ([`~transformers.PreTrainedConfig`]):
+                The model configuration.
+        Returns:
+            Tuple of (`torch.Tensor`, `float`), containing the inverse frequencies for the RoPE embeddings and the
+            post-processing scaling factor applied to the computed cos/sin (unused in this type of RoPE).
+        """
+        base = config.rope_parameters["rope_theta"]
+        dim = (
+            getattr(config, "head_dim", None)
+            or config.hidden_size // config.num_attention_heads
+        )
+
+        attention_factor = 1.0  # Unused in this type of RoPE
+        # Compute the inverse frequencies
+        inv_freq = 1.0 / (base ** (torch.arange(0, dim, 2, dtype=torch.float) / dim))
+        return inv_freq.to(device), attention_factor
+
+    @torch.no_grad()
+    @dynamic_rope_update  # power user: used with advanced RoPE types (e.g. dynamic rope)
+    def forward(self, x, position_ids):
+        inv_freq_expanded = (
+            self.inv_freq[None, :, None]
+            .expand(position_ids.shape[0], -1, 1)
+            .to(dtype=torch.float, device=x.device)
+        )
+        position_ids_expanded = position_ids[:, None, :].float()
+
+        device_type = (
+            x.device.type
+            if isinstance(x.device.type, str) and x.device.type != "mps"
+            else "cpu"
+        )
+        # Disable any outside autocast context if any, to really force fp32
+        with maybe_autocast(device_type=device_type, enabled=False):
+            freqs = (inv_freq_expanded @ position_ids_expanded).transpose(1, 2)
+            emb = torch.cat((freqs, freqs), dim=-1)
+            cos = emb.cos() * self.attention_scaling
+            sin = emb.sin() * self.attention_scaling
+
+        return cos.to(dtype=x.dtype), sin.to(dtype=x.dtype)
+
+
+def rotate_half(x):
+    """Rotates half the hidden dims of the input."""
+    x1 = x[..., : x.shape[-1] // 2]
+    x2 = x[..., x.shape[-1] // 2 :]
+    return torch.cat((-x2, x1), dim=-1)
+
+
+@use_kernel_forward_from_hub("rotary_pos_emb")
+def apply_rotary_pos_emb(q, k, cos, sin, unsqueeze_dim=1):
+    """Applies Rotary Position Embedding to the query and key tensors.
+
+    Args:
+        q (`torch.Tensor`): The query tensor.
+        k (`torch.Tensor`): The key tensor.
+        cos (`torch.Tensor`): The cosine part of the rotary embedding.
+        sin (`torch.Tensor`): The sine part of the rotary embedding.
+        unsqueeze_dim (`int`, *optional*, defaults to 1):
+            The 'unsqueeze_dim' argument specifies the dimension along which to unsqueeze cos[position_ids] and
+            sin[position_ids] so that they can be properly broadcasted to the dimensions of q and k. For example, note
+            that cos[position_ids] and sin[position_ids] have the shape [batch_size, seq_len, head_dim]. Then, if q and
+            k have the shape [batch_size, heads, seq_len, head_dim], then setting unsqueeze_dim=1 makes
+            cos[position_ids] and sin[position_ids] broadcastable to the shapes of q and k. Similarly, if q and k have
+            the shape [batch_size, seq_len, heads, head_dim], then set unsqueeze_dim=2.
+    Returns:
+        `tuple(torch.Tensor)` comprising of the query and key tensors rotated using the Rotary Position Embedding.
+    """
+    cos = cos.unsqueeze(unsqueeze_dim)
+    sin = sin.unsqueeze(unsqueeze_dim)
+    q_embed = (q * cos) + (rotate_half(q) * sin)
+    k_embed = (k * cos) + (rotate_half(k) * sin)
+    return q_embed, k_embed
+
+
+def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
+    """
+    This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch,
+    num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim)
+    """
+    batch, num_key_value_heads, slen, head_dim = hidden_states.shape
+    if n_rep == 1:
+        return hidden_states
+    hidden_states = hidden_states[:, :, None, :, :].expand(
+        batch, num_key_value_heads, n_rep, slen, head_dim
+    )
+    return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
+
+
+def eager_attention_forward(
+    module: nn.Module,
+    query: torch.Tensor,
+    key: torch.Tensor,
+    value: torch.Tensor,
+    attention_mask: torch.Tensor | None,
+    scaling: float,
+    dropout: float = 0.0,
+    **kwargs: Unpack[TransformersKwargs],
+):
+    key_states = repeat_kv(key, module.num_key_value_groups)
+    value_states = repeat_kv(value, module.num_key_value_groups)
+
+    attn_weights = torch.matmul(query, key_states.transpose(2, 3)) * scaling
+    if attention_mask is not None:
+        attn_weights = attn_weights + attention_mask
+
+    attn_weights = nn.functional.softmax(attn_weights, dim=-1, dtype=torch.float32).to(
+        query.dtype
+    )
+    attn_weights = nn.functional.dropout(
+        attn_weights, p=dropout, training=module.training
+    )
+    attn_output = torch.matmul(attn_weights, value_states)
+    attn_output = attn_output.transpose(1, 2).contiguous()
+
+    return attn_output, attn_weights
+
+
+@use_kernelized_func(apply_rotary_pos_emb)
+class UltrabertAttention(nn.Module):
+    """Multi-headed attention from 'Attention Is All You Need' paper"""
+
+    def __init__(self, config: UltrabertConfig, layer_idx: int):
+        super().__init__()
+        self.config = config
+        self.layer_idx = layer_idx
+        self.head_dim = getattr(
+            config, "head_dim", config.hidden_size // config.num_attention_heads
+        )
+        self.num_key_value_groups = (
+            config.num_attention_heads // config.num_key_value_heads
+        )
+        self.scaling = self.head_dim**-0.5
+        self.attention_dropout = config.attention_dropout
+        self.is_causal = False
+
+        self.q_proj = nn.Linear(
+            config.hidden_size,
+            config.num_attention_heads * self.head_dim,
+            bias=config.attention_bias,
+        )
+        self.k_proj = nn.Linear(
+            config.hidden_size,
+            config.num_key_value_heads * self.head_dim,
+            bias=config.attention_bias,
+        )
+        self.v_proj = nn.Linear(
+            config.hidden_size,
+            config.num_key_value_heads * self.head_dim,
+            bias=config.attention_bias,
+        )
+        self.o_proj = nn.Linear(
+            config.num_attention_heads * self.head_dim,
+            config.hidden_size,
+            bias=config.attention_bias,
+        )
+
+    def forward(
+        self,
+        hidden_states: torch.Tensor,
+        position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
+        attention_mask: torch.Tensor | None = None,
+        past_key_values: Cache | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> tuple[torch.Tensor, torch.Tensor]:
+        input_shape = hidden_states.shape[:-1]
+        hidden_shape = (*input_shape, -1, self.head_dim)
+
+        query_states = self.q_proj(hidden_states).view(hidden_shape).transpose(1, 2)
+        key_states = self.k_proj(hidden_states).view(hidden_shape).transpose(1, 2)
+        value_states = self.v_proj(hidden_states).view(hidden_shape).transpose(1, 2)
+
+        cos, sin = position_embeddings
+        query_states, key_states = apply_rotary_pos_emb(
+            query_states, key_states, cos, sin
+        )
+
+        if past_key_values is not None:
+            key_states, value_states = past_key_values.update(
+                key_states, value_states, self.layer_idx
+            )
+
+        attention_interface: Callable = ALL_ATTENTION_FUNCTIONS.get_interface(
+            self.config._attn_implementation, eager_attention_forward
+        )
+
+        attn_output, attn_weights = attention_interface(
+            self,
+            query_states,
+            key_states,
+            value_states,
+            attention_mask,
+            dropout=0.0 if not self.training else self.attention_dropout,
+            scaling=self.scaling,
+            **kwargs,
+        )
+
+        attn_output = attn_output.reshape(*input_shape, -1).contiguous()
+        attn_output = self.o_proj(attn_output)
+        return attn_output, attn_weights
+
+
+@use_kernel_forward_from_hub("RMSNorm")
+class UltrabertRMSNorm(nn.Module):
+    def __init__(self, hidden_size, eps: float = 1e-6) -> None:
+        """
+        UltrabertRMSNorm is equivalent to T5LayerNorm
+        """
+        super().__init__()
+        self.weight = nn.Parameter(torch.ones(hidden_size))
+        self.variance_epsilon = eps
+
+    def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
+        input_dtype = hidden_states.dtype
+        hidden_states = hidden_states.to(torch.float32)
+        variance = hidden_states.pow(2).mean(-1, keepdim=True)
+        hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon)
+        return self.weight * hidden_states.to(input_dtype)
+
+    def extra_repr(self):
+        return f"{tuple(self.weight.shape)}, eps={self.variance_epsilon}"
+
+
+class UltrabertMLP(nn.Module):
+    def __init__(self, config):
+        super().__init__()
+        self.config = config
+        self.hidden_size = config.hidden_size
+        self.intermediate_size = config.intermediate_size
+        self.gate_proj = nn.Linear(
+            self.hidden_size, self.intermediate_size, bias=config.mlp_bias
+        )
+        self.up_proj = nn.Linear(
+            self.hidden_size, self.intermediate_size, bias=config.mlp_bias
+        )
+        self.down_proj = nn.Linear(
+            self.intermediate_size, self.hidden_size, bias=config.mlp_bias
+        )
+        self.act_fn = ACT2FN[config.hidden_act]
+
+    def forward(self, x):
+        down_proj = self.down_proj(self.act_fn(self.gate_proj(x)) * self.up_proj(x))
+        return down_proj
+
+
+class UltrabertLayer(GradientCheckpointingLayer):
+    def __init__(self, config: UltrabertConfig, layer_idx: int):
+        super().__init__()
+        self.hidden_size = config.hidden_size
+
+        self.self_attn = UltrabertAttention(config=config, layer_idx=layer_idx)
+
+        self.mlp = UltrabertMLP(config)
+        self.input_layernorm = UltrabertRMSNorm(
+            config.hidden_size, eps=config.rms_norm_eps
+        )
+        self.post_attention_layernorm = UltrabertRMSNorm(
+            config.hidden_size, eps=config.rms_norm_eps
+        )
+
+    def forward(
+        self,
+        hidden_states: torch.Tensor,
+        attention_mask: torch.Tensor | None = None,
+        position_ids: torch.LongTensor | None = None,
+        past_key_values: Cache | None = None,
+        use_cache: bool | None = False,
+        position_embeddings: tuple[torch.Tensor, torch.Tensor] | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> torch.Tensor:
+        residual = hidden_states
+        hidden_states = self.input_layernorm(hidden_states)
+        # Self Attention
+        hidden_states, _ = self.self_attn(
+            hidden_states=hidden_states,
+            attention_mask=attention_mask,
+            position_ids=position_ids,
+            past_key_values=past_key_values,
+            use_cache=use_cache,
+            position_embeddings=position_embeddings,
+            **kwargs,
+        )
+        hidden_states = residual + hidden_states
+
+        # Fully Connected
+        residual = hidden_states
+        hidden_states = self.post_attention_layernorm(hidden_states)
+        hidden_states = self.mlp(hidden_states)
+        hidden_states = residual + hidden_states
+        return hidden_states
+
+
+@auto_docstring
+class UltrabertPreTrainedModel(PreTrainedModel):
+    config: UltrabertConfig
+    base_model_prefix = "ultrabert"
+    supports_gradient_checkpointing = True
+    _no_split_modules = ["UltrabertLayer"]
+    _skip_keys_device_placement = ["past_key_values"]
+    _supports_flash_attn = True
+    _supports_sdpa = True
+    _supports_flex_attn = True
+
+    _can_compile_fullgraph = True
+    _supports_attention_backend = True
+    _can_record_outputs = {
+        "hidden_states": UltrabertLayer,
+        "attentions": UltrabertAttention,
+    }
+    config_class = UltrabertConfig
+
+    def _init_weights(self, module):
+        super()._init_weights(module)
+        if isinstance(module, RotaryEmbedding):
+            inv_freq = torch.arange(0, module.dim, 2, dtype=torch.int64)
+            inv_freq = 1.0 / (
+                module.base
+                ** (
+                    inv_freq.to(device=module.inv_freq.device, dtype=torch.float)
+                    / module.dim
+                )
+            )
+            module.inv_freq.copy_(inv_freq)
+
+
+def create_local_attention_mask(
+    seq_len: int,
+    sliding_window: int | None = None,
+    device: torch.device | None = None,
+) -> torch.Tensor:
+    attention_mask = torch.ones(1, seq_len, seq_len, dtype=torch.bool, device=device)
+    if sliding_window:
+        attention_mask = attention_mask.tril(sliding_window).triu(-sliding_window)
+    return attention_mask
+
+
+@auto_docstring
+class UltrabertModel(UltrabertPreTrainedModel):
+    def __init__(self, config: UltrabertConfig):
+        super().__init__(config)
+        self.padding_idx = config.pad_token_id
+        self.vocab_size = config.vocab_size
+
+        self.embed_tokens = nn.Embedding(
+            config.vocab_size, config.hidden_size, self.padding_idx
+        )
+
+        self.layers = nn.ModuleList(
+            [UltrabertLayer(config, i) for i in range(config.num_hidden_layers)]
+        )
+        self.norm = UltrabertRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+        self.rotary_emb = nn.ModuleDict()
+        self.gradient_checkpointing = False
+        for base in set(config.rope_theta):
+            name = str(base).replace(".", "_")
+            self.rotary_emb[name] = RotaryEmbedding(base, config.head_dim)
+
+        # Initialize weights and apply final processing
+        self.post_init()
+
+    @merge_with_config_defaults
+    @capture_outputs
+    @auto_docstring
+    def forward(
+        self,
+        input_ids: torch.Tensor | None = None,
+        attention_mask: torch.Tensor | None = None,
+        position_ids: torch.Tensor | None = None,
+        inputs_embeds: torch.Tensor | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> BaseModelOutput:
+        if (input_ids is None) ^ (inputs_embeds is not None):
+            raise ValueError("must specify exactly one of input_ids or inputs_embeds")
+        if inputs_embeds is None:
+            inputs_embeds = self.embed_tokens(input_ids)
+        if position_ids is None:
+            position_ids = torch.arange(inputs_embeds.size(1))
+            position_ids = position_ids.to(inputs_embeds.device).unsqueeze(0)
+        if (
+            attention_mask is None
+            and self.config._attn_implementation != "flash_attention_2"
+        ):
+            attention_mask = inputs_embeds.new_ones(inputs_embeds.shape[:2])
+        varlen_kwargs = {
+            k: kwargs[k]
+            for k in ("cu_seq_lens_q", "cu_seq_lens_k", "max_length_q", "max_length_k")
+            if kwargs.get(k) is not None
+        }
+
+        # Create attention masks for different local window sizes and store by window.
+        attention_mask_dict = {}
+        for local_window in list(set(self.config.attention_windows)) + [None]:
+            if self.config._attn_implementation == "flash_attention_2":
+                # For FlashAttention 2, rely on the `sliding_window` keyword instead of
+                # constructing masks manually.
+                attention_mask_dict[local_window] = attention_mask
+            else:
+                window_mask = create_local_attention_mask(
+                    seq_len=attention_mask.size(1),
+                    sliding_window=local_window,
+                    device=attention_mask.device,
+                )
+                window_mask = window_mask & attention_mask.bool().unsqueeze(1)
+                attention_mask_dict[local_window] = (
+                    torch.where(window_mask, 0.0, torch.finfo(inputs_embeds.dtype).min)
+                    .to(inputs_embeds.dtype)
+                    .unsqueeze(1)
+                )
+
+        # Create position embeddings to be shared across the decoder layers.
+        hidden_states, position_embeddings = inputs_embeds, {}
+        for base in set(self.config.rope_theta):
+            rotary_emb = self.rotary_emb[str(base).replace(".", "_")]
+            position_embeddings[base] = rotary_emb(hidden_states, position_ids)
+
+        for i, decoder_layer in enumerate(self.layers[: self.config.num_hidden_layers]):
+            local_window = self.config.attention_windows[i]
+            hidden_states = decoder_layer(
+                hidden_states,
+                attention_mask=attention_mask_dict[local_window],
+                position_ids=position_ids,
+                position_embeddings=position_embeddings[self.config.rope_theta[i]],
+                sliding_window=(
+                    local_window + 1
+                    if local_window is not None
+                    and self.config._attn_implementation == "flash_attention_2"
+                    else local_window
+                ),
+                **varlen_kwargs,
+            )
+        hidden_states = self.norm(hidden_states)
+        return BaseModelOutput(last_hidden_state=hidden_states)
+
+
+class UltrabertPredictionHead(nn.Module):
+    def __init__(self, config: UltrabertConfig):
+        super().__init__()
+        if (dim := config.prediction_head_size) is not None:
+            self.linear1 = nn.Linear(config.hidden_size, dim, bias=False)
+            self.linear2 = nn.Linear(dim, config.hidden_size, bias=False)
+            self.act_fn = ACT2FN["gelu_pytorch_tanh"]
+
+    def forward(self, x: torch.Tensor) -> torch.Tensor:
+        if hasattr(self, "linear1"):
+            return self.act_fn(self.linear2(self.act_fn(self.linear1(x))))
+        return x
+
+
+@auto_docstring
+class UltrabertForMaskedLM(UltrabertPreTrainedModel):
+    _tied_weights_keys = {"cls.weight": "ultrabert.embed_tokens.weight"}
+
+    def __init__(self, config: UltrabertConfig):
+        super().__init__(config)
+        self.ultrabert = UltrabertModel(config)
+        self.head = UltrabertPredictionHead(config)
+        self.cls = nn.Linear(config.hidden_size, config.vocab_size, bias=False)
+
+        # Initialize weights and apply final processing
+        self.post_init()
+
+    def get_output_embeddings(self):
+        return self.cls
+
+    def set_output_embeddings(self, new_embeddings):
+        self.cls = new_embeddings
+
+    @can_return_tuple
+    @auto_docstring
+    def forward(
+        self,
+        input_ids: torch.Tensor | None = None,
+        attention_mask: torch.Tensor | None = None,
+        token_type_ids: torch.Tensor | None = None,
+        position_ids: torch.Tensor | None = None,
+        inputs_embeds: torch.Tensor | None = None,
+        labels: torch.Tensor | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> tuple[torch.Tensor] | MaskedLMOutput:
+        r"""
+        labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
+            Labels for computing the masked language modeling loss. Indices should be in `[-100, 0, ...,
+            config.vocab_size]` (see `input_ids` docstring) Tokens with indices set to `-100` are ignored (masked), the
+            loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]`
+        """
+        outputs = self.ultrabert(
+            input_ids,
+            attention_mask=attention_mask,
+            position_ids=position_ids,
+            inputs_embeds=inputs_embeds,
+            **kwargs,
+        )
+        prediction_scores = self.cls(self.head(outputs[0]))
+
+        masked_lm_loss = None
+        if labels is not None:
+            loss_fct = CrossEntropyLoss()  # -100 index = padding token
+            masked_lm_loss = loss_fct(
+                prediction_scores.view(-1, self.config.vocab_size), labels.view(-1)
+            )
+
+        return MaskedLMOutput(
+            loss=masked_lm_loss,
+            logits=prediction_scores,
+            hidden_states=outputs.hidden_states,
+            attentions=outputs.attentions,
+        )
+
+
+@auto_docstring(
+    custom_intro="""
+    Ultrabert Model transformer with a sequence classification/regression head on top (a linear layer on top of the pooled
+    output) e.g. for GLUE tasks.
+    """
+)
+class UltrabertForSequenceClassification(UltrabertPreTrainedModel):
+    def __init__(self, config: UltrabertConfig):
+        super().__init__(config)
+        self.num_labels = config.num_labels
+        self.config = config
+        self.ultrabert = UltrabertModel(config)
+        classifier_dropout = (
+            config.classifier_dropout
+            if config.classifier_dropout is not None
+            else config.hidden_dropout_prob
+        )
+        self.dropout = nn.Dropout(config.classifier_dropout)
+        self.classifier = nn.Linear(config.hidden_size, config.num_labels)
+
+        # Initialize weights and apply final processing
+        self.post_init()
+
+    @can_return_tuple
+    @auto_docstring
+    def forward(
+        self,
+        input_ids: torch.Tensor | None = None,
+        attention_mask: torch.Tensor | None = None,
+        token_type_ids: torch.Tensor | None = None,
+        position_ids: torch.Tensor | None = None,
+        inputs_embeds: torch.Tensor | None = None,
+        labels: torch.Tensor | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> tuple[torch.Tensor] | SequenceClassifierOutput:
+        r"""
+        labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
+            Labels for computing the sequence classification/regression loss. Indices should be in `[0, ...,
+            config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If
+            `config.num_labels > 1` a classification loss is computed (Cross-Entropy).
+        """
+        outputs = self.ultrabert(
+            input_ids,
+            attention_mask=attention_mask,
+            position_ids=position_ids,
+            inputs_embeds=inputs_embeds,
+            **kwargs,
+        )
+        logits = self.classifier(self.dropout(outputs[0][:, 0]))
+
+        loss = None
+        if labels is not None:
+            if self.config.problem_type is None:
+                if self.num_labels == 1:
+                    self.config.problem_type = "regression"
+                elif self.num_labels > 1 and (
+                    labels.dtype == torch.long or labels.dtype == torch.int
+                ):
+                    self.config.problem_type = "single_label_classification"
+                else:
+                    self.config.problem_type = "multi_label_classification"
+
+            if self.config.problem_type == "regression":
+                loss_fct = MSELoss()
+                if self.num_labels == 1:
+                    loss = loss_fct(logits.squeeze(), labels.squeeze())
+                else:
+                    loss = loss_fct(logits, labels)
+            elif self.config.problem_type == "single_label_classification":
+                loss_fct = CrossEntropyLoss()
+                loss = loss_fct(logits.view(-1, self.num_labels), labels.view(-1))
+            elif self.config.problem_type == "multi_label_classification":
+                loss_fct = BCEWithLogitsLoss()
+                loss = loss_fct(logits, labels)
+
+        return SequenceClassifierOutput(
+            loss=loss,
+            logits=logits,
+            hidden_states=outputs.hidden_states,
+            attentions=outputs.attentions,
+        )
+
+
+@auto_docstring
+class UltrabertForQuestionAnswering(UltrabertPreTrainedModel):
+    def __init__(self, config: UltrabertConfig):
+        super().__init__(config)
+        self.num_labels = config.num_labels
+
+        self.ultrabert = UltrabertModel(config)
+        self.qa_outputs = nn.Linear(config.hidden_size, config.num_labels)
+
+        # Initialize weights and apply final processing
+        self.post_init()
+
+    @can_return_tuple
+    @auto_docstring
+    def forward(
+        self,
+        input_ids: torch.Tensor | None = None,
+        attention_mask: torch.Tensor | None = None,
+        token_type_ids: torch.Tensor | None = None,
+        position_ids: torch.Tensor | None = None,
+        inputs_embeds: torch.Tensor | None = None,
+        start_positions: torch.Tensor | None = None,
+        end_positions: torch.Tensor | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> tuple[torch.Tensor] | QuestionAnsweringModelOutput:
+        outputs = self.ultrabert(
+            input_ids,
+            attention_mask=attention_mask,
+            position_ids=position_ids,
+            inputs_embeds=inputs_embeds,
+            **kwargs,
+        )
+        logits = self.qa_outputs(outputs[0])
+        start_logits, end_logits = logits.split(1, dim=-1)
+        start_logits = start_logits.squeeze(-1).contiguous()
+        end_logits = end_logits.squeeze(-1).contiguous()
+
+        total_loss = None
+        if start_positions is not None and end_positions is not None:
+            if len(start_positions.size()) > 1:
+                start_positions = start_positions.squeeze(-1)
+            if len(end_positions.size()) > 1:
+                end_positions = end_positions.squeeze(-1)
+
+            ignored_index = start_logits.size(1)
+            start_positions = start_positions.clamp(0, ignored_index)
+            end_positions = end_positions.clamp(0, ignored_index)
+
+            loss_fct = CrossEntropyLoss(ignore_index=ignored_index)
+            start_loss = loss_fct(start_logits, start_positions)
+            end_loss = loss_fct(end_logits, end_positions)
+            total_loss = (start_loss + end_loss) / 2
+
+        return QuestionAnsweringModelOutput(
+            loss=total_loss,
+            start_logits=start_logits,
+            end_logits=end_logits,
+            hidden_states=outputs.hidden_states,
+            attentions=outputs.attentions,
+        )
+
+
+@auto_docstring
+class UltrabertForTokenClassification(UltrabertPreTrainedModel):
+    def __init__(self, config: UltrabertConfig):
+        super().__init__(config)
+        self.num_labels = config.num_labels
+        self.ultrabert = UltrabertModel(config)
+        classifier_dropout = (
+            config.classifier_dropout
+            if config.classifier_dropout is not None
+            else config.hidden_dropout_prob
+        )
+        self.dropout = nn.Dropout(config.classifier_dropout)
+        self.classifier = nn.Linear(config.hidden_size, config.num_labels)
+
+        # Initialize weights and apply final processing
+        self.post_init()
+
+    @can_return_tuple
+    @auto_docstring
+    def forward(
+        self,
+        input_ids: torch.Tensor | None = None,
+        attention_mask: torch.Tensor | None = None,
+        token_type_ids: torch.Tensor | None = None,
+        position_ids: torch.Tensor | None = None,
+        inputs_embeds: torch.Tensor | None = None,
+        labels: torch.Tensor | None = None,
+        **kwargs: Unpack[TransformersKwargs],
+    ) -> tuple[torch.Tensor] | TokenClassifierOutput:
+        r"""
+        labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
+            Labels for computing the token classification loss. Indices should be in `[0, ..., config.num_labels - 1]`.
+        """
+        outputs = self.ultrabert(
+            input_ids,
+            attention_mask=attention_mask,
+            position_ids=position_ids,
+            inputs_embeds=inputs_embeds,
+            **kwargs,
+        )
+
+        sequence_output = outputs[0]
+
+        sequence_output = self.dropout(sequence_output)
+        logits = self.classifier(sequence_output)
+
+        loss = None
+        if labels is not None:
+            loss_fct = CrossEntropyLoss()
+            loss = loss_fct(logits.view(-1, self.num_labels), labels.view(-1))
+
+        return TokenClassifierOutput(
+            loss=loss,
+            logits=logits,
+            hidden_states=outputs.hidden_states,
+            attentions=outputs.attentions,
+        )

requirements.txt

@@ -0,0 +1,9 @@
+torch==2.11.0+cu128
+transformers==5.16.1
+accelerate==1.14.0
+datasets==4.8.5
+huggingface_hub==1.29.0
+safetensors==0.8.0
+numpy==2.1.3
+pandas==2.3.3
+scikit-learn==1.6.1

selection.json

@@ -0,0 +1,11 @@
+{
+  "learning_rate": 8e-06,
+  "validation_macro_f1": 0.9888320545609548,
+  "validation_accuracy": 0.9941002949852508,
+  "validation_loss": 0.04801607131958008,
+  "trained_epochs": 8.0,
+  "best_checkpoint": "ultrafinbert_runs/20261016T154623284896Z/trials/lr_8e-06/checkpoint-250",
+  "global_steps": 400,
+  "warmup_steps": 25,
+  "training_seconds": 450.235867831
+}

split_distribution.csv

@@ -0,0 +1,5 @@
+label_name,train,validation,test
+negative,212,45,46
+neutral,970,208,208
+positive,399,86,85
+total,1581,339,339

test_comparison.csv

@@ -0,0 +1,4 @@
+model,accuracy,balanced_accuracy,macro_f1,weighted_f1,macro_precision,macro_recall,log_loss,macro_f1_ci95_low,macro_f1_ci95_high,test_examples,truncation_rate,parameters,evaluation_dtype,revision,training_overlap_note
+beethogedeon/UltraFinBERT-150M,0.9646017699115044,0.9542543773362188,0.9615904929520475,0.9641735110013125,0.9702531262693043,0.9542543773362188,0.24856460459181326,0.9373423664558937,0.9814966497430953,339,0.0,151034883,torch.float16,local FP16 export,Held out from this fine-tuning run; upstream pretraining exposure not audited.
+ProsusAI/finbert,0.9823008849557522,0.9847408026755854,0.9775293265383634,0.9823943729157764,0.9708343294286398,0.9847408026755854,0.11372488239044834,0.9590552079097949,0.9945137250496199,339,0.0,109484547,torch.float16,0bc2ac10dda6929bcb1f77ccc43c7ec5c424f031,Previously fine-tuned on FinancialPhraseBank; overlap with this test is unknown and possible.
+beethogedeon/Modern-FinBERT-large,0.9823008849557522,0.9764705882352942,0.9748919274144381,0.9821485315052908,0.9748525002418029,0.9764705882352942,0.09822984893543157,0.9525722119021349,0.9916481561294743,339,0.0,395834371,torch.float16,a5dd04dae984a46e729698ca39f398181c9aaeea,Previously fine-tuned on FinancialPhraseBank; overlap with this test is unknown and possible.

test_comparison.json

@@ -0,0 +1,56 @@
+[
+  {
+    "model": "beethogedeon/UltraFinBERT-150M",
+    "accuracy": 0.9646017699115044,
+    "balanced_accuracy": 0.9542543773362188,
+    "macro_f1": 0.9615904929520475,
+    "weighted_f1": 0.9641735110013125,
+    "macro_precision": 0.9702531262693043,
+    "macro_recall": 0.9542543773362188,
+    "log_loss": 0.24856460459181326,
+    "macro_f1_ci95_low": 0.9373423664558937,
+    "macro_f1_ci95_high": 0.9814966497430953,
+    "test_examples": 339,
+    "truncation_rate": 0.0,
+    "parameters": 151034883,
+    "evaluation_dtype": "torch.float16",
+    "revision": "local FP16 export",
+    "training_overlap_note": "Held out from this fine-tuning run; upstream pretraining exposure not audited."
+  },
+  {
+    "model": "ProsusAI/finbert",
+    "accuracy": 0.9823008849557522,
+    "balanced_accuracy": 0.9847408026755854,
+    "macro_f1": 0.9775293265383634,
+    "weighted_f1": 0.9823943729157764,
+    "macro_precision": 0.9708343294286398,
+    "macro_recall": 0.9847408026755854,
+    "log_loss": 0.11372488239044834,
+    "macro_f1_ci95_low": 0.9590552079097949,
+    "macro_f1_ci95_high": 0.9945137250496199,
+    "test_examples": 339,
+    "truncation_rate": 0.0,
+    "parameters": 109484547,
+    "evaluation_dtype": "torch.float16",
+    "revision": "0bc2ac10dda6929bcb1f77ccc43c7ec5c424f031",
+    "training_overlap_note": "Previously fine-tuned on FinancialPhraseBank; overlap with this test is unknown and possible."
+  },
+  {
+    "model": "beethogedeon/Modern-FinBERT-large",
+    "accuracy": 0.9823008849557522,
+    "balanced_accuracy": 0.9764705882352942,
+    "macro_f1": 0.9748919274144381,
+    "weighted_f1": 0.9821485315052908,
+    "macro_precision": 0.9748525002418029,
+    "macro_recall": 0.9764705882352942,
+    "log_loss": 0.09822984893543157,
+    "macro_f1_ci95_low": 0.9525722119021349,
+    "macro_f1_ci95_high": 0.9916481561294743,
+    "test_examples": 339,
+    "truncation_rate": 0.0,
+    "parameters": 395834371,
+    "evaluation_dtype": "torch.float16",
+    "revision": "a5dd04dae984a46e729698ca39f398181c9aaeea",
+    "training_overlap_note": "Previously fine-tuned on FinancialPhraseBank; overlap with this test is unknown and possible."
+  }
+]

tokenizer_config.json

@@ -0,0 +1,36 @@
+{
+  "add_prefix_space": false,
+  "backend": "tokenizers",
+  "bos_token": "<|endoftext|>",
+  "clean_up_tokenization_spaces": false,
+  "eos_token": "<|endoftext|>",
+  "errors": "replace",
+  "extra_special_tokens": [
+    "<|endoftext|>",
+    "<|im_start|>",
+    "<|im_end|>",
+    "<repo_name>",
+    "<reponame>",
+    "<file_sep>",
+    "<filename>",
+    "<gh_stars>",
+    "<issue_start>",
+    "<issue_comment>",
+    "<issue_closed>",
+    "<jupyter_start>",
+    "<jupyter_text>",
+    "<jupyter_code>",
+    "<jupyter_output>",
+    "<|sep|>",
+    "<|mask|>"
+  ],
+  "is_local": false,
+  "local_files_only": false,
+  "mask_token": "<|mask|>",
+  "model_max_length": 256,
+  "pad_token": "<|endoftext|>",
+  "sep_token": "<|sep|>",
+  "tokenizer_class": "GPT2Tokenizer",
+  "unk_token": "<|endoftext|>",
+  "vocab_size": 49152
+}