Create README.md

README.md

@@ -0,0 +1,127 @@
+---
+license: cc-by-nc-4.0
+tags:
+- generated_from_trainer
+metrics:
+- precision
+- recall
+- f1
+- accuracy
+model-index:
+- name: roberta-es-clinical-trials-umls-7sgs-ner
+  results: []
+widget:
+- text: "Criterios de inclusión: 18 a 65 años; necrosis avascular de cadera; sintomática de menos de 6 meses; capaz de otorgar consentimiento informado. Criterios de exclusión: embarazo, lactancia, mujer fértil sin métodos anticonceptivos adecuados; tratamiento activo con bifosfonatos; infección por VIH, hepatitis B o hepatitis C; historia de neoplasia en cualquier organo."
+
+---
+
+<!-- This model card has been generated automatically according to the information the Trainer had access to. You
+should probably proofread and complete it, then remove this comment. -->
+
+# roberta-es-clinical-trials-umls-7sgs-ner
+
+This medical named entity recognition model detects 7 types of semantic groups from the [Unified Medical Language System (UMLS)](https://www.nlm.nih.gov/research/umls/index.html) ([Bodenreider 2004](https://academic.oup.com/nar/article/32/suppl_1/D267/2505235)):
+- ANAT: body parts and anatomy (e.g. *garganta*, 'throat')
+- CHEM: chemical entities and pharmacological substances (e.g. *aspirina*,'aspirin')
+- DEVI: medical devices (e.g. *catéter*, 'catheter')
+- DISO: pathologic conditions (e.g. *dolor*, 'pain')
+- LIVB: living beings (e.g. *paciente*, 'patient')
+- PHYS: physiological processes (e.g. *respiración*, 'breathing')
+- PROC: diagnostic and therapeutic procedures, laboratory analyses and medical research activities (e.g. *cirugía*, 'surgery')
+
+The model achieves the following results on the test set (when trained with the training and development set; results are averaged over 5 evaluation rounds):
+- Precision: 0.876 (±0.003)
+- Recall: 0.895 (±0.001)
+- F1: 0.885 (±0.001)
+- Accuracy: 0.960 (±0.001)
+
+
+## Model description
+
+This model adapts the pre-trained model [bsc-bio-ehr-es](https://huggingface.co/PlanTL-GOB-ES/bsc-bio-ehr-es), presented in [Pio Carriño et al. (2022)](https://aclanthology.org/2022.bionlp-1.19/). 
+It is fine-tuned to conduct medical named entity recognition on Spanish texts about clinical trials. 
+The model is fine-tuned on the [CT-EBM-ES corpus (Campillos-Llanos et al. 2021)](https://bmcmedinformdecismak.biomedcentral.com/articles/10.1186/s12911-021-01395-z).
+
+## Intended uses & limitations
+
+**Disclosure**: *This model is under development and needs to be improved. It should not be used for medical decision making without human assistance and supervision*
+
+This model is intended for a generalist purpose, and may have bias and/or any other undesirable distortions.
+
+Third parties who deploy or provide systems and/or services using any of these models (or using systems based on these models) should note that it is their responsibility to mitigate the risks arising from their use. Third parties, in any event, need to comply with applicable regulations, including regulations concerning the use of artificial intelligence.
+
+The owner or creator of the models will in no event be liable for any results arising from the use made by third parties of these models.
+
+**Descargo de responsabilidad**: *Esta herramienta se encuentra en desarrollo y no debe ser empleada para la toma de decisiones médicas*
+
+La finalidad de este modelo es generalista, y se advierte que puede tener sesgos y/u otro tipo de distorsiones indeseables.
+
+Terceras partes que desplieguen o proporcionen sistemas y/o servicios usando alguno de estos modelos (o utilizando sistemas basados en estos modelos) han tener presente que es su responsabilidad abordar y minimizar los riesgos derivados de su uso. Las terceras partes, en cualquier circunstancia, deben cumplir con la normativa aplicable, incluyendo la normativa que concierne al uso de la inteligencia artificial.
+
+El propietario o creador de los modelos de ningún modo será responsable de los resultados derivados del uso que las terceras partes hagan de estos modelos.
+
+
+## Training and evaluation data
+
+The data used for fine-tuning are the [Clinical Trials for Evidence-Based-Medicine in Spanish corpus](http://www.lllf.uam.es/ESP/nlpdata/wp2/).
+It is a collection of 1200 texts about clinical trials studies and clinical trials announcements:
+- 500 abstracts from journals published under a Creative Commons license, e.g. available in PubMed or the Scientific Electronic Library Online (SciELO)
+- 700 clinical trials announcements published in the European Clinical Trials Register and Repositorio Español de Estudios Clínicos
+
+If you use the CT-EBM-ES resource, please, cite as follows:
+
+```
+@article{campillosetal-midm2021,
+        title = {A clinical trials corpus annotated with UMLS© entities to enhance the access to Evidence-Based Medicine},
+        author = {Campillos-Llanos, Leonardo and Valverde-Mateos, Ana and Capllonch-Carri{\'o}n, Adri{\'a}n and Moreno-Sandoval, Antonio},
+        journal = {BMC Medical Informatics and Decision Making},
+        volume={21},
+        number={1},
+        pages={1--19},
+        year={2021},
+        publisher={BioMed Central}
+}
+```
+
+
+
+## Training procedure
+
+### Training hyperparameters
+
+The following hyperparameters were used during training:
+- learning_rate: 2e-05
+- train_batch_size: 16
+- eval_batch_size: 16
+- seed: we used different seeds for 5 evaluation rounds, and uploaded the model with the best results
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- num_epochs: 12 
+
+
+### Training results (test set; average and standard deviation of 5 rounds with different seeds)
+
+|   Precision    |     Recall     |       F1       |    Accuracy    |
+|:--------------:|:--------------:|:--------------:|:--------------:|
+| 0.876 (±0.003) | 0.895 (±0.001) | 0.885 (±0.001) | 0.960 (±0.001) |
+
+
+**Results per class (test set; average and standard deviation of 5 rounds with different seeds)**  
+
+| Class      |   Precision    |     Recall     |       F1       |  Support  |
+|:----------:|:--------------:|:--------------:|:--------------:|:---------:|
+| ANAT       | 0.726 (±0.027) | 0.695 (±0.019) | 0.710 (±0.018) |    307    |
+| CHEM       | 0.910 (±0.009) | 0.927 (±0.006) | 0.918 (±0.003) |   2932    |
+| DEVI       | 0.647 (±0.023) | 0.810 (±0.019) | 0.719 (±0.021) |    134    |
+| DISO       | 0.891 (±0.005) | 0.898 (±0.002) | 0.894 (±0.002) |   3064    |
+| LIVB       | 0.943 (±0.004) | 0.956 (±0.006) | 0.949 (±0.002) |   1671    |
+| PHYS       | 0.779 (±0.008) | 0.760 (±0.018) | 0.769 (±0.009) |    308    |
+| PROC       | 0.841 (±0.007) | 0.874 (±0.005) | 0.857 (±0.004) |   4150    |
+
+
+### Framework versions
+
+- Transformers 4.17.0
+- Pytorch 1.10.2+cu113
+- Datasets 1.18.4
+- Tokenizers 0.11.6