mmarimon commited on
Commit
6fc5ae8
1 Parent(s): 3fb1fc3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -25
README.md CHANGED
@@ -46,26 +46,35 @@ model-index:
46
  # Catalan BERTa (roberta-base-ca) finetuned for Semantic Textual Similarity.
47
 
48
  ## Table of Contents
49
- - [Model Description](#model-description)
50
- - [Intended Uses and Limitations](#intended-uses-and-limitations)
51
- - [How to Use](#how-to-use)
 
 
 
 
52
  - [Training](#training)
53
- - [Training Data](#training-data)
54
- - [Training Procedure](#training-procedure)
55
  - [Evaluation](#evaluation)
56
- - [Variable and Metrics](#variable-and-metrics)
57
- - [Evaluation Results](#evaluation-results)
58
- - [Licensing Information](#licensing-information)
59
- - [Citation Information](#citation-information)
60
- - [Funding](#funding)
61
- - [Contributions](#contributions)
62
- - [Disclaimer](#disclaimer)
 
 
 
 
 
63
 
64
  ## Model description
65
 
66
  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.
67
 
68
- ## Intended Uses and Limitations
69
 
70
  **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.
71
 
@@ -106,17 +115,20 @@ Expected output:
106
 
107
  <sup>1</sup> _**avoid using the widget** scores since they are normalized and do not reflect the original annotation values._
108
 
 
 
 
109
  ## Training
110
 
111
  ### Training data
112
  We used the STS dataset in Catalan called [STS-ca](https://huggingface.co/datasets/projecte-aina/sts-ca) for training and evaluation.
113
 
114
- ### Training Procedure
115
  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.
116
 
117
  ## Evaluation
118
 
119
- ### Variable and Metrics
120
 
121
  This model was finetuned maximizing the average score between the Pearson and Spearman correlations.
122
 
@@ -131,11 +143,24 @@ We evaluated the _roberta-base-ca-cased-sts_ on the STS-ca test set against stan
131
 
132
  For more details, check the fine-tuning and evaluation scripts in the official [GitHub repository](https://github.com/projecte-aina/club).
133
 
134
- ## Licensing Information
135
 
 
 
 
 
 
 
 
 
 
 
136
  [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
137
 
138
- ## Citation Information
 
 
 
139
  If you use any of these resources (datasets or models) in your work, please cite our latest paper:
140
  ```bibtex
141
  @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
159
  }
160
  ```
161
 
162
- ### Funding
163
- 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).
164
-
165
- ## Contributions
166
-
167
- [N/A]
168
-
169
  ### Disclaimer
170
 
171
  <details>
@@ -175,4 +193,4 @@ The models published in this repository are intended for a generalist purpose an
175
 
176
  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.
177
 
178
- 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.
 
46
  # Catalan BERTa (roberta-base-ca) finetuned for Semantic Textual Similarity.
47
 
48
  ## Table of Contents
49
+ <details>
50
+ <summary>Click to expand</summary>
51
+
52
+ - [Model description](#model-description)
53
+ - [Intended uses and limitations](#intended-use)
54
+ - [How to use](#how-to-use)
55
+ - [Limitations and bias](#limitations-and-bias)
56
  - [Training](#training)
57
+ - [Training data](#training-data)
58
+ - [Training procedure](#training-procedure)
59
  - [Evaluation](#evaluation)
60
+ - [Variable and metrics](#variable-and-metrics)
61
+ - [Evaluation results](#evaluation-results)
62
+ - [Additional information](#additional-information)
63
+ - [Author](#author)
64
+ - [Contact information](#contact-information)
65
+ - [Copyright](#copyright)
66
+ - [Licensing information](#licensing-information)
67
+ - [Funding](#funding)
68
+ - [Citing information](#citing-information)
69
+ - [Disclaimer](#disclaimer)
70
+
71
+ </details>
72
 
73
  ## Model description
74
 
75
  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.
76
 
77
+ ## Intended uses and limitations
78
 
79
  **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.
80
 
 
115
 
116
  <sup>1</sup> _**avoid using the widget** scores since they are normalized and do not reflect the original annotation values._
117
 
118
+ ## Limitations and bias
119
+ 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.
120
+
121
  ## Training
122
 
123
  ### Training data
124
  We used the STS dataset in Catalan called [STS-ca](https://huggingface.co/datasets/projecte-aina/sts-ca) for training and evaluation.
125
 
126
+ ### Training procedure
127
  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.
128
 
129
  ## Evaluation
130
 
131
+ ### Variable and metrics
132
 
133
  This model was finetuned maximizing the average score between the Pearson and Spearman correlations.
134
 
 
143
 
144
  For more details, check the fine-tuning and evaluation scripts in the official [GitHub repository](https://github.com/projecte-aina/club).
145
 
146
+ ## Additional information
147
 
148
+ ### Author
149
+ Text Mining Unit (TeMU) at the Barcelona Supercomputing Center ([email protected])
150
+
151
+ ### Contact information
152
+ For further information, send an email to [email protected]
153
+
154
+ ### Copyright
155
+ Copyright (c) 2022 Text Mining Unit at Barcelona Supercomputing Center
156
+
157
+ ### Licensing information
158
  [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
159
 
160
+ ### Funding
161
+ 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).
162
+
163
+ ### Citation Information
164
  If you use any of these resources (datasets or models) in your work, please cite our latest paper:
165
  ```bibtex
166
  @inproceedings{armengol-estape-etal-2021-multilingual,
 
184
  }
185
  ```
186
 
 
 
 
 
 
 
 
187
  ### Disclaimer
188
 
189
  <details>
 
193
 
194
  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.
195
 
196
+ 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.