Update README.md

README.md

@@ -16,20 +16,67 @@ metrics:
 ---
 
 # Spanish RoBERTa-base trained on BNE finetuned for Spanish Question Answering Corpus (SQAC) dataset.
+
+## Table of contents
+<details>
+<summary>Click to expand</summary>
+
+- [Model description](#model-description)
+- [Intended uses and limitations](#intended-use)
+- [How to use](#how-to-use)
+- [Limitations and bias](#limitations-and-bias)
+- [Training](#training)
+- [Evaluation](#evaluation)
+- [Additional information](#additional-information)
+  - [Author](#author)
+  - [Contact information](#contact-information)
+  - [Copyright](#copyright)
+  - [Licensing information](#licensing-information)
+  - [Funding](#funding)
+  - [Citing information](#citing-information)
+  - [Disclaimer](#disclaimer)
+  
+</details>
+
+## Model description
 RoBERTa-base-bne is a transformer-based masked language model for the Spanish language. It is based on the [RoBERTa](https://arxiv.org/abs/1907.11692) base model and has been pre-trained using the largest Spanish corpus known to date, with a total of 570GB of clean and deduplicated text processed for this work, compiled from the web crawlings performed by the  [National Library of Spain (Biblioteca Nacional de España)](http://www.bne.es/en/Inicio/index.html) from 2009 to 2019.
 
 Original pre-trained model can be found here: https://huggingface.co/PlanTL-GOB-ES/roberta-base-bne
 
-## Dataset
+## Intended uses and limitations
+
+## How to use
+
+## Limitations and bias
+At the time of submission, no measures have been taken to estimate the bias embedded in the model. However, we are well aware that our models may be biased since the corpora have been collected using crawling techniques on multiple web sources. We intend to conduct research in these areas in the future, and if completed, this model card will be updated.
+
+## Training
 The dataset used is the [SQAC corpus](https://huggingface.co/datasets/PlanTL-GOB-ES/SQAC).
 
-## Evaluation and results
+## Evaluation 
 F1 Score: 0.7923 (average of 5 runs).
 
 For evaluation details visit our [GitHub repository](https://github.com/PlanTL-GOB-ES/lm-spanish).
 
+## Additional information
+
+### Author
+Text Mining Unit (TeMU) at the Barcelona Supercomputing Center (bsc-temu@bsc.es)
+
+### Contact information
+For further information, send an email to <plantl-gob-es@bsc.es>
+
+### Copyright
+Copyright by the Spanish State Secretariat for Digitalization and Artificial Intelligence (SEDIA) (2022)
+
+### Licensing information
+[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+### Funding
+This work was funded by the Spanish State Secretariat for Digitalization and Artificial Intelligence (SEDIA) within the framework of the Plan-TL.
+
+### Citing information
 
-## Citing 
 If you use this model, please cite our [paper](http://journal.sepln.org/sepln/ojs/ojs/index.php/pln/article/view/6405):
 ```
 @article{,
@@ -50,19 +97,7 @@ Intelligence (SEDIA) within the framework of the Plan-TL.},
 
 ```
 
-## Copyright
-
-Copyright by the Spanish State Secretariat for Digitalization and Artificial Intelligence (SEDIA) (2022)
-
-## Licensing information
-
-[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
-
-## Funding
-
-This work was funded by the Spanish State Secretariat for Digitalization and Artificial Intelligence (SEDIA) within the framework of the Plan-TL.
-
-## Disclaimer
+### Disclaimer
 
 The models published in this repository are intended for a generalist purpose and are available to third parties. These models may have bias and/or any other undesirable distortions.