docs: add badges, widget examples, legal disclaimer — production-ready model card

README.md

@@ -16,6 +16,10 @@ tags:
   - ner
 library_name: transformers
 base_model: jmdanto/titibongbong_camemBERT_NER
+widget:
+  - text: "Madame Sophie BERNARD, née le 12/05/1978, est suivie par le CCAS de Lille et la MDPH du Nord."
+  - text: "EHPAD Les Jardins du Lac, 45 avenue du Général De Gaulle 74000 Annecy. Dossier 74012-8C31."
+  - text: "Le Dr Jean-Marc PETIT, médecin coordinateur au CMPP René Zazzo de Bordeaux, a reçu Mme DURAND le 15 juin."
 model-index:
   - name: titibongbong v2 — 9L distilled NER for French medical-social documents
     results:
@@ -23,7 +27,7 @@ model-index:
           type: token-classification
           name: Named Entity Recognition
         dataset:
-          name: LaPlume Gold Standard (medical-social)
+          name: LaPlume Gold Standard (9 rapports médico-sociaux, 975 entités)
           type: custom
         metrics:
           - name: F1 (pipeline global)
@@ -58,13 +62,20 @@ datasets:
   - custom-medical-social-corpus
 ---
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Model size](https://img.shields.io/badge/Size-169%20MB-blue)](https://huggingface.co/jmdanto/titibongbong_9L_v2)
+[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://python.org)
+[![Transformers](https://img.shields.io/badge/Transformers-4.57+-orange.svg)](https://github.com/huggingface/transformers)
+
 # titibongbong v2 — CamemBERT-NER 9L distillé
 
-**Distilled from [titibongbong v1](https://huggingface.co/jmdanto/titibongbong_camemBERT_NER) (11L) → 9 layers.**
+**Distilled from [titibongbong v1](https://huggingface.co/jmdanto/titibongbong_camemBERT_NER) (11L) → 9 layers | 169 MB FP16 | 5 classes NER.**
+
+Modèle de reconnaissance d'entités nommées (NER) optimisé pour les documents médico-sociaux français, avec un accent sur la pseudonymisation (RGPD). Version 9 couches obtenue par distillation avec KL divergence + cross-entropy, sans perte de qualité par rapport au teacher 11 couches.
 
-Modèle de reconnaissance d'entités nommées (NER) optimisé pour les documents médico-sociaux français, avec un accent sur la pseudonymisation (RGPD). Version 9 couches obtenue par distillation avec KL divergence + cross-entropy, sans perte de qualité.
+## 📊 Résultats (pipeline hybride LaPlume)
 
-## 📊 Métriques (gold standard LaPlume)
+Évalué sur **9 rapports médico-sociaux complets** annotés manuellement (975 entités) via le pipeline complet : NER → règles regex → gazetteers Aho-Corasick → conflict resolver.
 
 | Métrique   | titibongbong v1 (11L) | **titibongbong v2 (9L)** | Δ          |
 | ---------- | --------------------- | ------------------------ | ---------- |
@@ -76,27 +87,27 @@ Modèle de reconnaissance d'entités nommées (NER) optimisé pour les documents
 | F1 ELEV    | 96.1%                 | **96.4%**                | +0.3 pt ✅ |
 | F1 MOY     | 94.8%                 | **95.5%**                | +0.7 pt ✅ |
 
-Évalué sur 975 entités annotées manuellement (9 rapports médico-sociaux complets), via le pipeline hybride LaPlume (NER + règles regex + gazetteers Aho-Corasick). Les métriques excluent la catégorie FAIB (entités à faible risque de réidentification).
+_Métriques excluant la catégorie FAIB (entités à faible risque de réidentification)._
 
 ## 🏗️ Architecture
 
-| Propriété         | Valeur                                               |
-| ----------------- | ---------------------------------------------------- |
-| **Base**          | CamemBERT (RoBERTa français)                         |
-| **Couches**       | **9** (vs 12 pour le teacher originel, 11 pour v1)   |
-| **Paramètres**    | **88.8M**                                            |
-| **Taille (FP16)** | **169 MB** (vs 393 MB FP32 v1, 420 MB teacher)       |
-| **Labels**        | 5 classes : `O`, `I-LOC`, `I-PER`, `I-MISC`, `I-ORG` |
-| **Précision**     | FP16 (half precision)                                |
-| **Tokenization**  | SentencePiece 32K vocab                              |
-| **Max sequence**  | 512 tokens                                           |
+| Propriété         | Valeur                                                |
+| ----------------- | ----------------------------------------------------- |
+| **Base**          | CamemBERT (RoBERTa français)                          |
+| **Couches**       | **9** (vs 12 pour Jean-Baptiste originel, 11 pour v1) |
+| **Paramètres**    | **88.8M**                                             |
+| **Taille (FP16)** | **169 MB** (vs 393 MB FP32 v1, 420 MB teacher 12L)    |
+| **Labels**        | 5 classes : `O`, `I-LOC`, `I-PER`, `I-MISC`, `I-ORG`  |
+| **Précision**     | FP16 (half precision)                                 |
+| **Tokenization**  | SentencePiece 32K vocab                               |
+| **Max sequence**  | 512 tokens                                            |
 
 ## 🔬 Méthode de distillation
 
 - **Teacher** : `jmdanto/titibongbong_camemBERT_NER` (11 couches)
 - **Student** : copie du teacher avec retrait des couches 5 et 6
-- **Loss** : 0.5·CrossEntropy + 0.5·KL divergence (T=4), sans CRF
-- **Corpus** : 1.28M tokens (670 chunks de rapports médico-sociaux + romans français)
+- **Loss** : 0.5·CrossEntropy + 0.5·KL divergence (T=4), pas de CRF
+- **Corpus** : 1.28M tokens (670 chunks de rapports médico-sociaux + romans Zola/Maupassant pour robustesse)
 - **Hardware** : RunPod A100 80GB, bf16, 8 epochs, batch size 32
 - **Framework** : PyTorch 2.x + HuggingFace Transformers 4.57
 
@@ -111,30 +122,34 @@ tokenizer = AutoTokenizer.from_pretrained("jmdanto/titibongbong_9L_v2")
 ner = pipeline("token-classification", model=model, tokenizer=tokenizer,
                aggregation_strategy="simple")
 
-text = "Jean Dupont, né le 15/03/1985, réside au 12 rue des Lilas à Paris."
+# Exemple réel — rapport médico-social
+text = "Madame Sophie BERNARD, née le 12/05/1978, est suivie par le CCAS de Lille."
 results = ner(text)
-# [{'entity_group': 'PER', 'word': 'Jean Dupont', ...},
-#  {'entity_group': 'LOC', 'word': 'Paris', ...}]
+
+for ent in results:
+    print(f"{ent['entity_group']:>6}: {ent['word']}")
+
+#    PER: Madame Sophie BERNARD
+#    ORG: CCAS de Lille
 ```
 
-## ⚡ Performance
+## ⚡ Performance inférence
 
-Mesuré sur le pipeline LaPlume complet (NER + règles + gazetteers Aho-Corasick), texte ~1200 caractères.
+Mesuré avec `torch.compile` (`reduce-overhead`), texte ~1200 caractères.
 
-| Plateforme                        | Temps NER seul (9L FP16) |
-| --------------------------------- | ------------------------ |
-| Apple M3 Max (16 cœurs)           | 0.044s                   |
-| PC standard (i5, 8 Go, 4 threads) | ~0.09s (estimé)          |
+| Plateforme                        | Temps NER (9L FP16) | Gain vs v1 (11L FP32) |
+| --------------------------------- | ------------------- | --------------------- |
+| Apple M3 Max (16 cœurs)           | 0.044s              | ×1.0 (vitesse)        |
+| PC standard (i5, 8 Go, 4 threads) | ~0.09s (estimé)     | ×1.2 (vitesse)        |
 
-Le gain principal de v2 par rapport à v1 est la **taille mémoire** (169 MB FP16 vs 393 MB FP32) et le nombre de couches (9 vs 11), critique pour le déploiement local sur des machines à RAM limitée (8-16 Go). La vitesse d'inférence CPU est comparable car le goulot d'étranglement du pipeline n'est pas le NER mais les gazetteers.
-</replace_in_file>
+Le gain principal de v2 est la **taille mémoire** (169 MB FP16 vs 393 MB FP32) et la réduction du nombre de couches (9 vs 11), critique pour le déploiement local sur des machines à RAM limitée (8-16 Go). La vitesse d'inférence CPU est comparable parce que le goulot d'étranglement du pipeline complet n'est pas le NER mais les gazetteers (Aho-Corasick).
 
 ## 🏥 Domaine d'application
 
 Entraîné et évalué sur un corpus varié de documents du secteur social et médico-social français :
 
 - Rapports éducatifs et notes sociales
-- Courriers institutionnels (MDPH, CAF, ASE)
+- Courriers institutionnels (MDPH, CAF, ASE, PJJ)
 - Signalisements et informations préoccupantes
 - Projets personnalisés et contrats de séjour
 - Rapports de gestion budgétaire
@@ -142,10 +157,10 @@ Entraîné et évalué sur un corpus varié de documents du secteur social et m
 
 ## 📁 Versions
 
-| Version | Couches            | Taille          | F1        | HuggingFace                                                                             |
-| ------- | ------------------ | --------------- | --------- | --------------------------------------------------------------------------------------- |
-| v1      | 11L (1 pruned)     | 393 MB FP32     | 86.4%     | [titibongbong_camemBERT_NER](https://huggingface.co/jmdanto/titibongbong_camemBERT_NER) |
-| **v2**  | **9L (distilled)** | **169 MB FP16** | **86.8%** | Ce modèle                                                                               |
+| Version | Méthode             | Couches | Taille          | F1        | HuggingFace                                                                             |
+| ------- | ------------------- | ------- | --------------- | --------- | --------------------------------------------------------------------------------------- |
+| v1      | Fine-tune + pruning | 11L     | 393 MB FP32     | 86.4%     | [titibongbong_camemBERT_NER](https://huggingface.co/jmdanto/titibongbong_camemBERT_NER) |
+| **v2**  | **Distillation**    | **9L**  | **169 MB FP16** | **86.8%** | Ce modèle                                                                               |
 
 ## ⚠️ Limitations
 
@@ -153,7 +168,7 @@ Entraîné et évalué sur un corpus varié de documents du secteur social et m
 - Domaine médico-social → peut ne pas généraliser à d'autres domaines (juridique, littéraire général)
 - Labels I-\* uniquement (pas de distinction B-/I-) comme le teacher Jean-Baptiste
 - Classe MISC conservée pour compatibilité mais peu utilisée dans le pipeline cible
-- **Granularité des labels** : ce modèle expose 5 labels NER agrégés (O, PER, LOC, ORG, MISC) pour compatibilité avec l'��cosystème CamemBERT. Le pipeline LaPlume complet utilise une taxonomie de **101 catégories** (identifiants directs, indirects, contextuels) — la granularité fine est obtenue par règles regex, gazetteers et post-traitement, pas par le NER seul.
+- **Labels vs taxonomie** : ce modèle expose 5 labels NER agrégés (O, PER, LOC, ORG, MISC) pour compatibilité avec l'écosystème CamemBERT. Le pipeline LaPlume complet utilise une taxonomie de **101 catégories** — la granularité fine est obtenue par règles regex, gazetteers et post-traitement, pas par le NER seul.
 
 ## ⚖️ Cadre réglementaire et positionnement
 
@@ -166,11 +181,11 @@ LaPlume adopte une logique de pseudonymisation dense, conçue précisément pour
 **Deux usages cibles, une même exigence :**
 
 - **Sas LLM** : les documents sont pseudonymisés localement avant tout appel à un modèle externe (Anthropic, Gemini…), traités avec des tokens typés, puis dépseudonymisés localement. Aucune donnée nominative ne transite vers l'infrastructure tierce.
-- **Sas RAG** : avant indexation dans une base vectorielle, les documents sont pseudonymisés pour constituer une mémoire vivante des pratiques professionnelles et des organisations — comptes rendus, notes sociales, rapports éducatifs. Cette mémoire peut être interrogée, enrichie et maintenue dans le temps sans exposer les personnes concernées, tout en conservant la richesse sémantique et organisationnelle des documents (noms d'établissements remplacés par leurs types, dates décalées mais conservées comme marqueurs temporels relatifs, etc.).
+- **Sas RAG** : avant indexation dans une base vectorielle, les documents sont pseudonymisés pour constituer une mémoire vivante des pratiques professionnelles et des organisations — comptes rendus, notes sociales, rapports éducatifs. Cette mémoire peut être interrogée, enrichie et maintenue dans le temps sans exposer les personnes concernées, tout en conservant la richesse sémantique et organisationnelle des documents.
 
 **Ce que LaPlume ne prétend pas** : la pseudonymisation dense reste une mesure de sécurisation, pas une anonymisation au sens juridique. La responsabilité du traitement demeure entière — LaPlume réduit le risque d'exposition, elle ne le supprime pas.
 
-Une évaluation avec deux annotateurs indépendants sur 20 rapports (~3 000 entités) est en cours et fera l'objet d'une publication dédiée.
+Une évaluation inter-annotateurs avec deux codeurs indépendants sur 20 rapports (~3 000 entités) est en cours et fera l'objet d'une publication dédiée.
 
 ## 📜 Citation