Update README.md

README.md

@@ -46,26 +46,35 @@ model-index:
 # Catalan BERTa (roberta-base-ca) finetuned for Semantic Textual Similarity.
 
 ## Table of Contents
-- [Model Description](#model-description)
-- [Intended Uses and Limitations](#intended-uses-and-limitations)
-- [How to Use](#how-to-use)
+<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)
-  - [Training Data](#training-data)
-  - [Training Procedure](#training-procedure)
+  - [Training data](#training-data)
+  - [Training procedure](#training-procedure)
 - [Evaluation](#evaluation)
-   - [Variable and Metrics](#variable-and-metrics)
-   - [Evaluation Results](#evaluation-results)
-- [Licensing Information](#licensing-information)
-- [Citation Information](#citation-information)
-- [Funding](#funding)
-- [Contributions](#contributions)
-- [Disclaimer](#disclaimer)
+   - [Variable and metrics](#variable-and-metrics)
+   - [Evaluation results](#evaluation-results)
+- [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
 
 The **roberta-base-ca-cased-sts** is a Semantic Textual Similarity (STS) model for the Catalan language fine-tuned from the roberta-base-ca model, a [RoBERTa](https://arxiv.org/abs/1907.11692) base model pre-trained on a medium-size corpus collected from publicly available corpora and crawlers.
 
-## Intended Uses and Limitations
+## Intended uses and limitations
 
 **roberta-base-ca-cased-sts** model can be used to assess the similarity between two snippets of text. The model is limited by its training dataset and may not generalize well for all use cases.
 
@@ -106,17 +115,20 @@ Expected output:
 
 <sup>1</sup> _**avoid using the widget** scores since they are normalized and do not reflect the original annotation values._
 
+## 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
 
 ### Training data
 We used the STS dataset in Catalan called [STS-ca](https://huggingface.co/datasets/projecte-aina/sts-ca) for training and evaluation.
 
-### Training Procedure
+### Training procedure
 The model was trained with a batch size of 16 and a learning rate of 5e-5 for 5 epochs. We then selected the best checkpoint using the downstream task metric in the corresponding development set, and then evaluated it on the test set.
 
 ## Evaluation
 
-### Variable and Metrics
+### Variable and metrics
 
 This model was finetuned maximizing the average score between the Pearson and Spearman correlations.
 
@@ -131,11 +143,24 @@ We evaluated the _roberta-base-ca-cased-sts_ on the STS-ca test set against stan
 
 For more details, check the fine-tuning and evaluation scripts in the official [GitHub repository](https://github.com/projecte-aina/club).
 
-## Licensing Information
+## Additional information
 
+### Author
+Text Mining Unit (TeMU) at the Barcelona Supercomputing Center ([email protected])
+
+### Contact information
+For further information, send an email to [email protected]
+
+### Copyright
+Copyright (c) 2022 Text Mining Unit at Barcelona Supercomputing Center 
+
+### Licensing information
 [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
-## Citation Information 
+### Funding
+This work was funded by the [Departament de la Vicepresidència i de Polítiques Digitals i Territori de la Generalitat de Catalunya](https://politiquesdigitals.gencat.cat/ca/inici/index.html#googtrans(ca|en) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
+
+### Citation Information  
 If you use any of these resources (datasets or models) in your work, please cite our latest paper:
 ```bibtex
 @inproceedings{armengol-estape-etal-2021-multilingual,
@@ -159,13 +184,6 @@ If you use any of these resources (datasets or models) in your work, please cite
 }
 ```
 
-### Funding
-This work was funded by the [Departament de la Vicepresidència i de Polítiques Digitals i Territori de la Generalitat de Catalunya](https://politiquesdigitals.gencat.cat/ca/inici/index.html#googtrans(ca|en) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
-
-## Contributions
-
-[N/A]
-
 ### Disclaimer
 
 <details>
@@ -175,4 +193,4 @@ The models published in this repository are intended for a generalist purpose an
 
 When third parties, deploy or provide systems and/or services to other parties using any of these models (or using systems based on these models) or become users of the models, they should note that it is their responsibility to mitigate the risks arising from their use and, in any event, to comply with applicable regulations, including regulations regarding the use of Artificial Intelligence.
 
-In no event shall the owner and creator of the models (BSC – Barcelona Supercomputing Center) be liable for any results arising from the use made by third parties of these models.
+In no event shall the owner and creator of the models (BSC – Barcelona Supercomputing Center) be liable for any results arising from the use made by third parties of these models.