inoid commited on
Commit
0245f06
1 Parent(s): 6d7bf82

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +192 -1
README.md CHANGED
@@ -156,4 +156,195 @@ para un autojuste del modelo y en el caso de que el texto se `open_text` un pre-
156
 
157
  ## Dataset Card Contact
158
 
159
- For any doubt or suggestion contact to: PhD Dionis López (inoid2007@gmail.com)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
156
 
157
  ## Dataset Card Contact
158
 
159
+ For any doubt or suggestion contact to: PhD Dionis López (inoid2007@gmail.com)
160
+
161
+ <!-- ###################################################################################################################### --->
162
+
163
+ <!--
164
+ 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
165
+
166
+ ¿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.
167
+
168
+ 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
169
+
170
+ Para más información sobre la dataset card metadata ver: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
171
+ -->
172
+
173
+ # Dataset Card for < Nombre del corpus >
174
+
175
+ <!-- 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. -->
176
+
177
+ <!-- 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. -->
178
+
179
+ <!-- Si queréis incluir una versión de la Dataset Card en español, enlazarla aquí al principio (e.g. `README_es.md`).-->
180
+
181
+ ## Dataset Details
182
+
183
+ ### Dataset Description
184
+
185
+ <!-- Resumen del dataset. -->
186
+
187
+ - **Curated by:** [More Information Needed] <!-- Nombre de los miembros del equipo -->
188
+ - **Funded by:** SomosNLP, HuggingFace, Argilla <!-- Si contasteis con apoyo de otra entidad (e.g. vuestra universidad), añadidla aquí -->
189
+ - **Language(s) (NLP):** [More Information Needed] <!-- 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`). -->
190
+ - **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 -->
191
+
192
+ ### Dataset Sources
193
+
194
+ - **Repository:** [More Information Needed] <!-- Enlace al `main` del repo donde tengáis los scripts, i.e.: o del mismo repo del dataset en HuggingFace o a GitHub. -->
195
+ - **Paper [optional]:** [More Information Needed] <!-- 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. -->
196
+ - **Demo:** [optional] [More Information Needed] <!-- Enlace a la demo del dataset -->
197
+ - **Video presentation:** [optional] [More Information Needed] <!-- Enlace a vuestro vídeo de presentación en YouTube (están todos subidos aquí: https://www.youtube.com/playlist?list=PLTA-KAy8nxaASMwEUWkkTfMaDxWBxn-8J) -->
198
+
199
+ ### Dataset Versions & Formats [optional]
200
+
201
+ <!-- Si tenéis varias versiones de vuestro dataset podéis combinarlas todas en un mismo repo y simplemente enlazar aquí los commits correspondientes. Ver ejemplo de https://huggingface.co/bertin-project/bertin-roberta-base-spanish -->
202
+
203
+ <!-- Si hay varias formatos del dataset (e.g. sin anotar, pregunta/respuesta, gemma) las podéis enumerar aquí. -->
204
+
205
+ ## Uses
206
+
207
+ <!-- Address questions around how the dataset is intended to be used. -->
208
+
209
+ ### Direct Use
210
+
211
+ <!-- This section describes suitable use cases for the dataset. -->
212
+
213
+ [More Information Needed]
214
+
215
+ ### Out-of-Scope Use
216
+
217
+ <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
218
+
219
+ [More Information Needed]
220
+
221
+ ## Dataset Structure
222
+
223
+ <!-- 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. -->
224
+
225
+ <!-- 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. -->
226
+
227
+ [More Information Needed]
228
+
229
+ ## Dataset Creation
230
+
231
+ ### Curation Rationale
232
+
233
+ <!-- Motivation for the creation of this dataset. -->
234
+
235
+ [More Information Needed]
236
+
237
+ ### Source Data
238
+
239
+ <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
240
+
241
+ #### Data Collection and Processing
242
+
243
+ <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
244
+
245
+ <!-- Enlazar aquí los scripts y notebooks utilizados para generar el corpus. -->
246
+
247
+ [More Information Needed]
248
+
249
+ #### Who are the source data producers?
250
+
251
+ <!-- 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. -->
252
+
253
+ [More Information Needed]
254
+
255
+ ### Annotations [optional]
256
+
257
+ <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
258
+
259
+ #### Annotation process
260
+
261
+ <!-- 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. -->
262
+
263
+ <!-- Enlazar aquí el notebook utilizado para crear el espacio de anotación de Argilla y la guía de anotación. -->
264
+
265
+ [More Information Needed]
266
+
267
+ #### Who are the annotators?
268
+
269
+ <!-- This section describes the people or systems who created the annotations. -->
270
+
271
+ [More Information Needed]
272
+
273
+ #### Personal and Sensitive Information
274
+
275
+ <!-- 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. -->
276
+
277
+ [More Information Needed]
278
+
279
+ ## Bias, Risks, and Limitations
280
+
281
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
282
+
283
+ <!-- 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. -->
284
+
285
+ [More Information Needed]
286
+
287
+ ### Recommendations
288
+
289
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations.
290
+
291
+ Example:
292
+
293
+ Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. -->
294
+
295
+ [More Information Needed]
296
+
297
+ ## License
298
+
299
+ <!-- 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). -->
300
+
301
+ ## Citation
302
+
303
+ <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
304
+
305
+ **BibTeX:**
306
+
307
+ [More Information Needed]
308
+
309
+ <!--
310
+
311
+ Aquí tenéis un ejemplo de cita de un dataset que podéis adaptar:
312
+
313
+ ```
314
+ @software{benallal2024cosmopedia,
315
+ author = {Ben Allal, Loubna and Lozhkov, Anton and Penedo, Guilherme and Wolf, Thomas and von Werra, Leandro},
316
+ title = {Cosmopedia},
317
+ month = February,
318
+ year = 2024,
319
+ url = {https://huggingface.co/datasets/HuggingFaceTB/cosmopedia}
320
+ }
321
+ ```
322
+
323
+ - benallal2024cosmopedia -> nombre + año + nombre del dataset
324
+ - author: lista de miembros del equipo
325
+ - title: nombre del dataset
326
+ - year: año
327
+ - url: enlace al dataset
328
+
329
+ -->
330
+
331
+ ## Glossary [optional]
332
+
333
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
334
+
335
+ ## More Information
336
+
337
+ <!-- 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. -->
338
+
339
+ 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.
340
+
341
+ **Team:** [More Information Needed]
342
+
343
+ <!--
344
+ - [Name 1](Link to Hugging Face profile)
345
+ - [Name 2](Link to Hugging Face profile)
346
+ -->
347
+
348
+ ## Contact [optional]
349
+
350
+ <!-- Email de contacto para´posibles preguntas sobre el dataset. -->