Update README.md

README.md

@@ -68,7 +68,120 @@ dataset_info:
     num_examples: 997
   download_size: 675236
   dataset_size: 2797070
+license: apache-2.0
+task_categories:
+- token-classification
+language:
+- gl
+pretty_name: GalicianSRL
+size_categories:
+- 1K<n<10K
 ---
-# Dataset Card for "galician_srl"
+# Dataset Card for GalicianSRL
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Limitations](#limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Citation Information](#citation-information)
+
+## Dataset Description
+
+- **Repository:** [GalicianSRL Project Hub](https://github.com/mbruton0426/GalicianSRL)
+- **Paper:** To be updated 
+- **Point of Contact:** [Micaella Bruton](mailto:[email protected])
+
+### Dataset Summary
+
+The GalicianSRL dataset is a Galician-language dataset of tokenized sentences and the semantic role for each token within a sentence. Semantic roles are limited to verbal roots, argument 0, argument 1, and argument 2. This dataset was created to support the task of semantic role labeling in the Galician language, as no publically available datasets existed as of the date of publication to the contributor's knowledge.
+
+### Languages
+
+The text in the dataset is in Galician.
+
+## Dataset Structure
+
+### Data Instances
+
+A typical data point comprises a tokenized sentence, tags for each token, and a sentence id number. An example from the GalicianSRL dataset looks as follows:
+```
+{'tokens': ['O', 'Pleno', 'poderá', ',', 'con', 'todo', ',', 'avocar', 'en', 'calquera', 'momento', 'o', 'debate', 'e', 'votación', 'de', 'calquera', 'proxecto', 'ou', 'proposición', 'de', 'lei', 'que', 'xa', 'fora', 'obxecto', 'de', 'esta', 'delegación', '.'],
+ 'tags': [0, 1, 4, 0, 0, 0, 0, 17, 0, 0, 16, 0, 15, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+ 'ids': 504}
+```
+Tags are assigned an id number according to the index of its label as listed in:
+
+```python
+>>> dataset['train'].features[f"tags"].feature.names
+```
+
+### Data Fields
+
+- `tokens`: a list of strings
+- `tags`: a list of integers
+- `ids`: a sentence id, as an integer
+
+### Data Splits
+
+The data is split into a training and test set. The final structure and split sizes are as follow:
+
+```
+DatasetDict({
+    train: Dataset({
+        features: ['tokens', 'tags', 'ids'],
+        num_rows: 1005
+    })
+    test: Dataset({
+        features: ['tokens', 'tags', 'ids'],
+        num_rows: 252
+    })
+})
+```
+
+## Dataset Creation
+
+### Curation Rationale
+
+GalicianSRL was built to provide a dataset for semantic role labeling in Galician and expand NLP resources available for the Galician language. 
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+Data was collected from both the [CTG UD annotated corpus](https://github.com/UniversalDependencies/UD_Galician-CTG) and the [TreeGal UD annotated corpus](https://github.com/UniversalDependencies/UD_Galician-TreeGal), and combined to collect the requsite information for this task. For more information, please refer to the publication listed in the citation.
+
+## Considerations for Using the Data
+
+### Limitations
+
+The purpose of this dataset is to help develop a working semantic role labeling system for Galician, as SRL systems have been shown to improve a variety of NLP tasks. It should be noted however that Galician is considered a low-resource language at this time, and as such the dataset has an extrememly limited scope. This dataset would benefit from manual validation of a native speaker of Galician, the inclusion of additional sentences, and an extention of arguments past arg0, arg1, and arg2.
+
+## Additional Information
+
+### Dataset Curators
+
+The dataset was created by Micaella Bruton, as part of her Master's thesis.
+
+### Citation Information
+
+```
+@mastersthesis{bruton-galician-srl-23,
+    author = {Bruton, Micaella},
+    title = {BERTie Bott's Every Flavor Labels: A Tasty Guide to Developing a Semantic Role Labeling Model for Galician},
+    school = {Uppsala University},
+    year = {2023},
+    type = {Master's thesis},
+}
+```