Update README.md

README.md

@@ -1,31 +1,74 @@
-# nc_ner_bert_model
+# nc_ner_bert_model_german_hyperparameter
 
-This model is a fine-tuned version of bert-base-german-cased on the german-ler dataset.  
-It achieves the following results on the evaluation set:
+Dieses Modell ist eine feinjustierte Variante von `bert-base-german-cased` und wurde auf dem `german-ler`-Datensatz mit **feingranularen juristischen Entitäten** trainiert.  
+Es unterscheidet 19 spezifische Klassen wie z. B. Gerichte, Gesetze, Institutionen, Marken oder Literaturverweise und eignet sich zur präzisen juristischen Informationsextraktion.
 
-Loss: 0.010967588983476162
-F1: 0.974421209858103
-Precision: 0.9677359540144632
-Recall: 0.9811994735852604
+## Evaluationsergebnisse
 
-## Model description
-More information needed
+- **F1-Score (micro avg)**: 0.9744  
+- **Precision (micro avg)**: 0.9677  
+- **Recall (micro avg)**: 0.9812  
+- **Loss**: 0.010967588983476162
 
-## Intended uses & limitations
-More information needed
+### Klassenweise Metriken (fine level)
 
-## Training and evaluation data
-More information needed
+| Klasse | Bedeutung     | Coarse | Coarse Bedeutung     | Precision | Recall  | F1-Score | Support |
+|--------|---------------|--------|-----------------------|-----------|---------|----------|---------|
+| PER    | Person        | PER    | Person                | 0.9195    | 0.9249  | 0.9222   | 173     |
+| RR     | Judge         | PER    | Person                | 1.0000    | 1.0000  | 1.0000   | 142     |
+| AN     | Lawyer        | PER    | Person                | 1.0000    | 1.0000  | 1.0000   | 6       |
+| LD     | Country       | LOC    | Location              | 0.9854    | 0.9060  | 0.9441   | 149     |
+| ST     | City          | LOC    | Location              | 0.9016    | 0.8594  | 0.8800   | 64      |
+| STR    | Street        | LOC    | Location              | 0.8667    | 0.8667  | 0.8667   | 15      |
+| LDS    | Landscape     | LOC    | Location              | 0.6000    | 0.9545  | 0.7368   | 22      |
+| ORG    | Organization  | ORG    | Organization          | 0.9224    | 0.9469  | 0.9345   | 113     |
+| UN     | Company       | ORG    | Organization          | 0.9813    | 0.9722  | 0.9767   | 108     |
+| INN    | Institution   | ORG    | Organization          | 0.9351    | 0.9730  | 0.9536   | 222     |
+| GRT    | Court         | ORG    | Organization          | 0.9969    | 0.9938  | 0.9953   | 321     |
+| MRK    | Brand         | ORG    | Organization          | 0.9412    | 1.0000  | 0.9697   | 32      |
+| GS     | Law           | NRM    | Legal norm            | 0.9821    | 0.9934  | 0.9877   | 1818    |
+| VO     | Ordinance     | NRM    | Legal norm            | 0.9254    | 0.8732  | 0.8986   | 71      |
+| EUN    | EU legal norm | NRM    | Legal norm            | 0.9481    | 0.9733  | 0.9605   | 150     |
+| VS     | Regulation    | REG    | Case-by-c. regul.     | 0.7176    | 0.9531  | 0.8188   | 64      |
+| VT     | Contract      | REG    | Case-by-c. regul.     | 0.9599    | 0.9897  | 0.9745   | 290     |
+| RS     | Court dec.    | RS     | Court decision        | 0.9896    | 0.9920  | 0.9908   | 1245    |
+| LIT    | Legal lit.    | LIT    | Legal literature      | 0.9628    | 0.9904  | 0.9765   | 314     |
 
-## Training procedure
+### Durchschnittswerte:
 
-### Training hyperparameters
-The following hyperparameters were used during training:
+- **Macro avg (F1)**: 0.9362  
+- **Weighted avg (F1)**: 0.9749  
 
-- learning_rate: 2.2349781891934193e-05
-- train_batch_size: (32,)
-- eval_batch_size: (32,)
-- num_epochs: 7
+---
+
+## Hinweis zur Metrikwahl
+
+Für die Gesamteinschätzung wird der **micro-average F1-Score** herangezogen, da hier **alle Vorhersagen gleich gewichtet** werden – unabhängig von der Klassengröße. Dies ist bei sequenzbasierten NER-Aufgaben sinnvoll, da jede Token-Entscheidung den gleichen Einfluss auf die Gesamtleistung hat.
+
+### Überblick über die Metriktypen:
+
+- **Micro average**: Gesamtanzahl aller True Positives, False Positives und False Negatives → *alle Klassenbeiträge gleich gewichtet*  
+- **Macro average**: Durchschnitt der Metriken über alle Klassen → *alle Klassen gleich wichtig*, unabhängig vom Support  
+- **Weighted average**: Durchschnitt über alle Klassen, *gewichtet nach Klassengröße* → häufige Klassen haben mehr Einfluss  
+
+---
+
+## Trainingskonfiguration
+
+- **Modell**: `bert-base-german-cased`  
+- **Datensatz**: `german-ler` (BIO-annotiert)  
+- **Trainingsepochen**: 7  
+- **Batchgröße**: 32  
+- **Lernrate**: 2.235e-5  
+- **Weight Decay**: 0.0881  
+- **Evaluation alle**: 200 Schritte  
+- **Selektion nach**: F1-Score (bestes Modell gespeichert)
+
+---
+
+## Nutzung
+
+Das Modell eignet sich für juristische NER-Anwendungen, bei denen eine präzise und differenzierte Extraktion juristisch relevanter Entitäten aus deutschsprachigen Rechtstexten erforderlich ist – z. B. in der Schriftsatzanalyse, Vertragsprüfung oder beim Aufbau juristischer Wissensdatenbanken.
 
 ### Training results