README.md

---
language:
- es
- en
license: apache-2.0
dataset_info:
  features:
  - name: raw_text
    dtype: string
  - name: topic
    dtype: string
  - name: speciallity
    dtype: string
  - name: raw_text_type
    dtype: string
  - name: topic_type
    dtype: string
  - name: source
    dtype: string
  - name: country
    dtype: string
  - name: document_id
    dtype: string
  splits:
  - name: train
    num_bytes: 190710909
    num_examples: 2136490
  download_size: 48472707
  dataset_size: 190710909
configs:
- config_name: default
  data_files:
  - split: train
    path: data/train-*
task_categories:
- question-answering
- zero-shot-classification
- text-generation
pretty_name: SMC
---

<!-- ###################################################################################################################### --->

 <!--
Esta plantilla de Dataset Card es una adaptación de la de Hugging Face: https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md

¿Cómo utilizar esta plantilla? Copia el contenido en el README.md del repo de tu dataset en el Hub de Hugging Face y rellena cada sección.

Para más información sobre cómo rellenar cada sección ver las docs: https://huggingface.co/docs/hub/datasets-cards y https://huggingface.co/docs/datasets/dataset_card

Para más información sobre la dataset card metadata ver: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
-->

# Dataset Card for Spanish Medical Corpus (SMC)

<!-- Suele haber un nombre corto ("pretty name") para las URLs, tablas y demás y uno largo más descriptivo. Para crear el pretty name podéis utilizar acrónimos. -->

<!-- Resumen del corpus y motivación del proyecto (inc. los ODS relacionados). Esta sección es como el abstract. También se puede incluir aquí el logo del proyecto. -->

<!-- Si queréis incluir una versión de la Dataset Card en español, enlazarla aquí al principio (e.g. `README_es.md`).-->

Este dataset agrupa y organiza varios dataset presentes en hugginface (p.ej: PlanTL-GOB-ES/cantemist-ner, PlanTL-GOB-ES/pharmaconer) 
y otros recursos públicos creados por investigadores con distintos formatos (p.ej.; MedLexSp ) 
para permitir ser fuente de conocimiento de grandes modelos de lenguaje en idioma español para el dominio médico.

<!--
  This dataset groups and organizes several datasets present in hugginface (e.g.: PlanTL-GOB-ES/cantemist-ner, PlanTL-GOB-ES/pharmaconer)
  and other public resources created by researchers with different formats (e.g.; MedLexSp ) to allow it to be a source of knowledge of large language models 
  in Spanish for the medical domain.
-->

[**Dataset Card in Spanish**](README_es.md)

## Dataset Details

### Dataset Description

<!-- Resumen del dataset. -->

- **Curated by:** [Dionis López Ramos](https://www.linkedin.com/in/dionis-lopez-ramos/), [Alvaro Garcia Barragan](https://huggingface.co/Alvaro8gb), [Dylan Montoya](https://huggingface.co/dylanmontoya22), [Daniel Bermúdez](https://huggingface.co/Danielbrdz)   <!-- Nombre de los miembros del equipo -->
- **Funded by:** SomosNLP, HuggingFace, Argilla, Universidad de Oriente (Cuba) <!-- Si contasteis con apoyo de otra entidad (e.g. vuestra universidad), añadidla aquí -->
- **Language(s) (NLP):**  Spanish (`es-ES`, `es-CL`)  <!-- Enumerar las lenguas en las que se ha entrenado el modelo, especificando el país de origen. Utilizar códigos ISO. Por ejemplo: Spanish (`es-CL`, `es-ES`, `es-MX`), Catalan (`ca`), Quechua (`qu`).  -->
- **License:** apache-2.0 <!-- Elegid una licencia lo más permisiva posible teniendo en cuenta la licencia del model pre-entrenado y los datasets utilizados -->

### Dataset Sources

- **Repository:** [somosnlp/SMC](https://huggingface.co/datasets/somosnlp/SMC/tree/main)
- **Paper:** "Comming soon!" <!-- Si vais a presentarlo a NAACL poned "WIP", "Comming soon!" o similar. Si no tenéis intención de presentarlo a ninguna conferencia ni escribir un preprint, eliminar. -->
- **Demo:** [somosnlp/SMC/viewer](https://huggingface.co/datasets/somosnlp/SMC/viewer)
- **Video presentation:** [ SpanishMedicaLLM | Proyecto Hackathon #SomosNLP ](https://www.youtube.com/watch?v=tVe_MC7Da6k) <!-- Enlace a vuestro vídeo de presentación en YouTube (están todos subidos aquí: https://www.youtube.com/playlist?list=PLTA-KAy8nxaASMwEUWkkTfMaDxWBxn-8J) -->

## Uses

<!-- Address questions around how the dataset is intended to be used. -->
 Se sugiere el uso de este dataset para lograr el autojuste y prentrenamiento de LLM para el dominio médico con información en idioma español.

### Direct Use

<!-- This section describes suitable use cases for the dataset. -->
Fine Tuning an LLM instruction in Spanish language with question prompts and answers.

### Out-of-Scope Use

<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
Los creadores del dataset no se hacen responsable de resultados nocivos que puedan generar los modelos al ser entrenados con esta información.
Se sugiere un proceso de evaluación riguroso con especialistas de los resultados generados por modelos de LLM entrenados.

## Dataset Structure

<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->

<!-- En esta sección podéis enumerar y explicar cada columna del corpus. Para cada columna que sea de tipo "categoría" podéis indicar el porcentaje de ejemplos. -->

Por cada entrada o documento en la fuente de información organizarla en un dataset de hugginface de la siguiente forma:

- **question (raw_text)**: Texto asociado al documento, pregunta, caso clínico u otro tipo de información.
- **answer (topic)**: (Texto asociado al tratamiento médico (healthcare_treatment), diagnóstico (healthcare_diagnosis),
             tópico de salud (topic),  respuesta de una pregunta (answer), other, o estar vacío p.ej en el texto abierto)
- **speciality**: (Especialidad médica a la que se relaciona el raw_text p.ej: cardiología, cirugía, otros)
- **raw_text_type**: (Puede ser clinic_case, open_text, question o vacio)
- **topic_type**: (Puede ser medical_topic, medical_diagnostic,answer,natural_medicine_topic, other, o vacio)
- **source**: Identificador de la fuente asociada al documento que aparece en el README  y  descripción del dataset.
- **country**: Identificador del país de procedencia de la fuente (p.ej.; ch, es) usando el estándar ISO 3166-1 alfa-2 (Códigos de país de dos letras.).
- **document_id**: Identificador del documento en el dataset de procedencia, este valor puede estar vacio en caso que no se conozca
<!-- - **idioma**: (Variedad geográfica) código ISO del idioma -->
<!--- **registro** (Variedad funcional): Siempre es  `medio`.  -->
<!-- - **periodo** (Variedad histórica):  Siempre es `actual`.  -->
<!-- - **dominio**: salud (clínico, biomédico, farmacia). -->
<!-- - **tarea**: `pregunta` | `resumen` | `open_text` | `clinic_case`.  -->
<!--  - **país_origen**:  País de origen de los datos. -->
  
Al inicio de este proceso de construcción se debe actualizar en la tabla de la sección [Source Data](#source_data) la 
descripción de la fuente de información con los siguientes datos: 

- **Id**: Este será un número para que la fuente de información pueda ser referenciada en cada entrada del conjunto de datos.
- **Nombre**: Nombre de la fuente de donde procede.
- **Tokens**: Cantidad de tokens que contiene.
- **Memoria**: Tamaño en memoria del dataset generado para hugginface
- **Licencia**: En este caso si es solo para investigación o si posee otra licencia como MIT, 
               Apache 2 u otras
- **Dirección**: URL de donde se puede descargar o consultar la información.
- **País**: País de procedencia de la información usando el [standar ISO 3166-1](https://es.wikipedia.org/wiki/ISO_3166-1) código alfa-2: Código ISO de 2 letras asignado a ese país o territorio.
  

## Dataset Creation

### Curation Rationale

<!-- Motivation for the creation of this dataset. -->
Más de 600 millones de personas hablantes del idioma español necesitan recursos, como los LLMs, para la obtención de información médica de forma libre
y segura, cumpliendo con los objetivo del milenio: Salud y Bienestar, Educación y Calidad, Fin de la Pobreza propuestos por la ONU. 
Existen pocos recursos o conjuntos de datos del dominio médico para el entrenamiento o autoajuste de un LLM en idioma español.

Para entrenar un autoajustar un LLM en el dominio de la medicina y los cuidados de salud se necesitan gran cantidad de datos de este contexto.
Para crear un conjunto de datos en el dominio médico es necesaria alguna certificación por especialistas en la construcción del corpus.

### Source Data

<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->

| Id | Nombre | Tokens | Memoria | Licencia | Dirección | País |
| --- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | 
| 1 | Cantemist corpus: gold standard of oncology clinical cases annotated with CIE-O 3 terminology | 349287 | 9157 kB | [CC Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) | https://huggingface.co/datasets/bigbio/cantemist/viewer/cantemist_bigbio_kb | es |
| 2 | MedlinePlus Spanish (National Library of Medicine, NLM) | 7757337 | 35 MB |  | https://medlineplus.gov/spanish/ | es |
| 3 | PharmaCoNER  | 275955 | 2 MB | [CC Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) | https://huggingface.co/datasets/PlanTL-GOB-ES/pharmaconer | es |
| 4 | Spanish Biomedical Crawled Corpus  | 1973048 | 264 MB | cc-by-4.0 | https://zenodo.org/records/5513237 | es |
| 5 | CARES  | 322353 | 1828 kB | Afl-3.0 | https://huggingface.co/datasets/chizhikchi/CARES | es |
| 6 | MEDDOCAN  | 364462 | 1639 kB | cc-by-4.0 | https://huggingface.co/datasets/bigbio/meddocan | es |
| 7 | Alvaro8gb/enfermedades-wiki-marzo-2024  | 1424685 | 9073 kB | [MIT](https://choosealicense.com/licenses/mit/) | https://huggingface.co/datasets/Alvaro8gb/enfermedades-wiki-marzo-2024 | es |
| 8 | BioMistral/BioInstructQA(**spanish**)  | 1072476 | 5963 kB | [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) | https://huggingface.co/datasets/BioMistral/BioInstructQA | ca |
| 9 | DisTEMIST  | 550203 | 2754 kB | cc-by-4.0  | https://huggingface.co/datasets/bigbio/distemist | es |
| 10 | The Chilean Waiting List Corpus  | 678934 | 3116 kB | cc-by-4.0  | https://zenodo.org/records/5518225 or https://huggingface.co/plncmm | cl |
| 11 | BARR2  | 1732432 | 8472 kB | cc-by-4.0  | https://temu.bsc.es/BARR2/downloads/background_set.raw_text.tar.bz2 | es |
| 12 | SPACC  | 551849 | 2711 kB | cc-by-4.0  | https://zenodo.org/records/2560316 | es |
| 13 | MedLexSp | 608374 | 21 MByte | MedLexSp is distributed freely for research or educational purposes. You need to sign an agreement with the authors for other purposes. | https://digital.csic.es/handle/10261/270429 | es |



#### Data Collection and Processing

<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->

<!-- Enlazar aquí los scripts y notebooks utilizados para generar el corpus. -->
  - [Cantemist corpus](./catemist) 
  - [MedlinePlus Spanish (National Library of Medicine](./medlineplus_spanish)
  - [PharmaCoNER](./pharmaconer)
  - [Spanish Biomedical Crawled Corpus](./spanish_biomedical_craw_corpus)
  - [CARES](./cares)
  - [MEDDOCAN](./meddocan)
  - [Alvaro8gb/enfermedades-wiki-marzo-2024](./wikipedia_datasets)
  - [BioMistral/BioInstructQA(**spanish**)](./spanish_biomedical_craw_corpus)
  - [DisTEMIST](./distemist)
  - [The Chilean Waiting List Corpus](./chileancaselist)
  - [BARR2](./barr2)
  - [SPACC](./spaccc)
  - [MedLexSp](./medlexsp)


**Sugerencias:**
 - En el caso de [BioMistral/BioInstructQA](https://huggingface.co/datasets/BioMistral/BioInstructQA) se utilizó la información en idioma español. Para más información consultar el artículo [BioMistral: A Collection of Open-Source Pretrained Large Language Models for Medical Domains](https://arxiv.org/pdf/2402.10373.pdf?trk=public_post_comment-text).
 - Para [Cantemist](https://huggingface.co/datasets/bigbio/cantemist/viewer/cantemist_bigbio_kb) se hizo una búsqueda del código asociado a la patología y se estableció como tópico.
 - En [CARES](https://huggingface.co/datasets/chizhikchi/CARES) se busco el tipo asociado en la tabla de códigos establecido.
   
#### Who are the source data producers?

<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->

Diferentes eventos, competencias de PLN o la construcción de los conjuntos de datos para LLM como BioMistral. Ver [tabla en la sección Source Data](#Source)


#### Annotation process

<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->

<!-- Enlazar aquí el notebook utilizado para crear el espacio de anotación de Argilla y la guía de anotación. -->

El proceso de anotacion fue automático, realizando la converción de las fuentes de datos a los atributos del nuevo conjunto de datos.

#### Who are the annotators?

<!-- This section describes the people or systems who created the annotations. -->
Ver la sección [Team](#Team)

#### Personal and Sensitive Information

<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->

En el proceso de construcción se tuvo en cuenta que no se incluyeran datos sensibles de los usuarios en ninguno de los casos (p.ej.; casos clinicos).

<!-- In the construction process, it was taken into account that sensitive user data was not included in any of the cases (e.g., clinical cases). -->


## Bias, Risks, and Limitations

<!-- This section is meant to convey both technical and sociotechnical limitations. -->

<!-- Aquí podéis mencionar los posibles sesgos heredados según el origen de los datos y de las personas que lo han anotado, hablar del balance de las categorías representadas, los esfuerzos que habéis hecho para intentar mitigar sesgos y riesgos. -->

Se sugiere tener en cuenta el alcance de las licencia de cada una de las fuentes (e.d., revisar el campo source y Licencia de la tabla anterior).

En el caso de necesitar filtrar por fuente de datos u otro criterio usted puede auxiliarse de las propiedades de la estructura de datos `Dataset` del marco de trabajo
Hugginface. En el siguiente ejemplo de código se obtienen del conjunto de datos las entradas que tienen un tipo de tópico sobre diagnóstico medico o un tópico médico:


```

  spanishMedicaLllmDataset =
      load_dataset(SPANISH_MEDICA_LLM_DATASET, split="train")
      
  spanishMedicaLllmDataset =
      spanishMedicaLllmDataset.filter(lambda example: example["topic_type"] in ['medical_diagnostic' | 'medical_topic'])
```

### Recommendations

<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations.

Example:

Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. -->

Los usuarios deben ser conscientes de los riesgos, sesgos y limitaciones del conjunto de datos.

Para el autojuste de un LLM se sugiere tener en cuenta las filas donde el tipo del tópico (ed., campo topic_type) tenga valores: `medical_topic`, 
`medical_diagnostic`, `answer`, `natural_medicine_topic`. Porque indica que este campo no está vacio y tiene valor para la creación de intrucciones de la 
forma pregunta y respuestas.

Para el prentrenamiento de un LLM se sugiere tener en cuenta cuando el campo `raw_text_type` sea igual a `open_text`. Esto indica que el texto
presente no forma parte de un formato pregunta/respuesta pero tiene un valor importante para el prentrenamiento de un LLM.

<!--  
   In case of using this dataset for the LLM training or finetuning for natural language generating with a production 
   environment target, we do not recommend the use of these results without a rigorous medical 
   specialists evaluation and evaluation with higth performances values.
-->   

## License

<!-- Indicar bajo qué licencia se libera el dataset explicando, si no es apache 2.0, a qué se debe la licencia más restrictiva (i.e. herencia de los datos utilizados). -->

Apache License 2.0
## Citation

<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->

**BibTeX:**

```
@software{lopez2024spanishmedicallm,
  author = {Lopez Dionis, Garcia Alvaro, Montoya Dylan, Bermúdez Daniel},
  title = {SpanishMedicaLLM},
  month = February,
  year = 2024,
  url = {https://huggingface.co/datasets/HuggingFaceTB/cosmopedia}
}
```

<!--

Aquí tenéis un ejemplo de cita de un dataset que podéis adaptar:

```
@software{benallal2024cosmopedia,
  author = {Ben Allal, Loubna and Lozhkov, Anton and Penedo, Guilherme and Wolf, Thomas and von Werra, Leandro},
  title = {Cosmopedia},
  month = February,
  year = 2024,
  url = {https://huggingface.co/datasets/HuggingFaceTB/cosmopedia}
}
```

- benallal2024cosmopedia -> nombre + año + nombre del dataset
- author: lista de miembros del equipo
- title: nombre del dataset
- year: año
- url: enlace al dataset

-->

## More Information

<!-- Indicar aquí que el marco en el que se desarrolló el proyecto, en esta sección podéis incluir agradecimientos y más información sobre los miembros del equipo. Podéis adaptar el ejemplo a vuestro gusto. -->

This project was developed during the [Hackathon #Somos600M](https://somosnlp.org/hackathon) organized by SomosNLP. The dataset was created using `distilabel` by Argilla and endpoints sponsored by HuggingFace.

**Team:**

<!--
- [Name 1](Link to Hugging Face profile)
- [Name 2](Link to Hugging Face profile)
-->
 - [Dionis López Ramos](https://huggingface.co/inoid)
 - [Alvaro Garcia Barragan](https://huggingface.co/Alvaro8gb)
 - [Dylan Montoya](https://huggingface.co/dylanmontoya22)
 - [Daniel Bermúdez](https://huggingface.co/Danielbrdz) 

## Contact

 For any doubt or suggestion contact to: PhD Dionis López (inoid2007@gmail.com)