Drbert CASM2

## 🚀 DrBERT-CASM2

**DrBERT-CASM2**は、フランス語の固有表現認識モデルです。これは、[DrBERT](https://huggingface.co/Dr-BERT/DrBERT-4GB-CP-PubMedBERT)（生物医学および臨床分野向けのフランス語の事前学習モデル）からファインチューニングされました。medkit Trainerを使用して、**problem**、**treatment**、**test**の3種類のエンティティを検出するように学習されています。

## 🚀 クイックスタート

### モデルの概要
**DrBERT-CASM2**は、フランス語の固有表現認識モデルで、[DrBERT](https://huggingface.co/Dr-BERT/DrBERT-4GB-CP-PubMedBERT) からファインチューニングされました。この事前学習モデルは、生物医学および臨床分野向けのフランス語モデルです。medkit Trainerを使用して、**problem**、**treatment**、**test** のエンティティを検出するように訓練されています。

- **ファインチューニングに使用**：medkit [GitHubリポジトリ](https://github.com/TeamHeka/medkit)
- **開発者**：@camila-ud、medkit、HeKA Research team
- **データセットのソース**：
  - @aneurazによる注釈付きバージョン 'corpusCasM2: A corpus of annotated clinical texts'。注釈付けは、Université Paris Citéの修士学生によって共同で行われました。
  - コーパスにはCASのドキュメントが含まれています。
    ```
    Natalia Grabar, Vincent Claveau, and Clément Dalloux. 2018. CAS: French Corpus with Clinical Cases.
    In Proceedings of the Ninth International Workshop on Health Text Mining and Information Analysis,
    pages 122–128, Brussels, Belgium. Association for Computational Linguistics.
    ```

### 想定される用途と制限
#### 制限とバイアス
このモデルは**開発およびテストフェーズ**用に訓練されています。訓練データセットによる制限があり、注意して使用する必要があります。結果は保証されず、データ探索段階でのみ使用するべきです。このモデルは、フランス語の医療文書の分析の初期段階でエンティティを検出できる可能性があります。

訓練時間を最小限に抑えるため、最大トークンサイズは**128トークン**に減らされています。

### 使い方
####  medkitのインストール
まず、次のコマンドでmedkitをインストールしてください。

pip install 'medkit-lib[optional]'

詳細と例については、[ドキュメント](https://medkit.readthedocs.io/en/latest/user_guide/install.html)を参照してください。

#### モデルの使用
```python
from medkit.core.text import TextDocument
from medkit.text.ner.hf_entity_matcher import HFEntityMatcher

matcher = HFEntityMatcher(model="medkit/DrBERT-CASM2")

test_doc = TextDocument("Elle souffre d'asthme mais n'a pas besoin d'Allegra")
detected_entities = matcher.run([test_doc.raw_segment])

# show information
msg = "|".join(f"'{entity.label}':{entity.text}" for entity in detected_entities)
print(f"Text: '{test_doc.text}'\n{msg}")

Text: "Elle souffre d'asthme mais n'a pas besoin d'Allegra"
'problem':asthme|'treatment':Allegra

訓練データ

このモデルは、修士学生によって注釈付けされた臨床事例を含む内部コーパスであるCASM2を使用してファインチューニングされました。コーパスには、検出対象のエンティティを含む5000以上のmedkitドキュメント（フレーズ）が含まれています。

分割ごとのドキュメント数（フレーズ）

分割	# medkitドキュメント
訓練	5824
検証	1457
テスト	1821

エンティティタイプごとの例の数

分割	treatment	test	problem
訓練	3258	3990	6808
検証	842	1007	1745
テスト	994	1289	2113

訓練手順

このモデルは、medkit trainerを使用してCPU上でファインチューニングされ、約3時間かかりました。

モデルの性能

CASM2テストデータセットで計算されたモデルの性能（medkit seqeval evaluatorを使用）

エンティティ	精度	再現率	F1値
treatment	0.7492	0.7666	0.7578
test	0.7449	0.8240	0.7824
problem	0.6884	0.7304	0.7088
全体	0.7188	0.7660	0.7416

medkitを使用した評価方法

from medkit.text.metrics.ner import SeqEvalEvaluator

# load the matcher and get predicted entities by document
matcher = HFEntityMatcher(model="medkit/DrBERT-CASM2")
predicted_entities = [matcher.run([doc.raw_segment]) for doc in test_documents]

evaluator  = SeqEvalEvaluator(tagging_scheme="iob2")
evaluator.compute(test_documents,predicted_entities=predicted_entities)

文字ではなくトークンで評価する場合は、HFのトークナイザーを使用できます。

from transformers import AutoTokenizer

tokenizer_drbert = AutoTokenizer.from_pretrained("medkit/DrBERT-CASM2", use_fast=True)

evaluator  = SeqEvalEvaluator(tokenizer=tokenizer_drbert,tagging_scheme="iob2")
evaluator.compute(test_documents,predicted_entities=predicted_entities)

引用

@online{medkit-lib,
  author={HeKA Research Team},
  title={medkit, A Python library for a learning health system},
  url={https://pypi.org/project/medkit-lib/},
  urldate = {2023-07-24}, 
}

HeKA Research Team, “medkit, a Python library for a learning health system.” https://pypi.org/project/medkit-lib/ (accessed Jul. 24, 2023).

📄 ライセンス

このモデルはMITライセンスの下で提供されています。