add documentation

README.md

@@ -1,3 +1,52 @@
 ---
-license: mit
+license: cc-by-4.0
+language: en
 ---
+
+This is the skill dataset created by:
+
+```
+@inproceedings{green-etal-2022-development,
+    title = "Development of a Benchmark Corpus to Support Entity Recognition in Job Descriptions",
+    author = "Green, Thomas  and
+      Maynard, Diana  and
+      Lin, Chenghua",
+    booktitle = "Proceedings of the Thirteenth Language Resources and Evaluation Conference",
+    month = jun,
+    year = "2022",
+    address = "Marseille, France",
+    publisher = "European Language Resources Association",
+    url = "https://aclanthology.org/2022.lrec-1.128",
+    pages = "1201--1208",
+}
+```
+
+There are no document delimiters, task is on the sentence-level.
+
+Number of samples (sentences):
+- train: 8669
+- dev: 964
+- test: 335
+
+Sources:
+- TotalJobs (UK): https://www.kaggle.com/datasets/airiddha/trainrev1
+
+Type of tags:
+- Generic BIO tags with key `tags_skill`
+- Finer grained labels of BIO tags are 
+  - `SKILL`: Tasks that can be performed, or attributes and abilities (including soft skills) that enable people to perform tasks.
+  - `QUALIFICATION`: Official certifications obtained through taking a course or passing an exam or appraisal.
+  - `EXPERIENCE`: Lengths of time relating to a position or skill.
+  - `OCCUPATION`: Job titles, including abbreviations and acronyms.
+  - `DOMAIN`: Areas of industry in which someone might have knowledge or experience.
+- Also has part-of-speech tags, indicated by `pos`.
+
+Sample:
+```
+{
+    "idx": 959, 
+    "tokens": ["negotiating", "and", "commercial", "skills", "Conscientious", "and", "thorough", "by", "nature"], 
+    "tags_skill": ["B-SKILL", "I-SKILL", "I-SKILL", "I-SKILL", "I-SKILL", "O", "B-SKILL", "O", "O"], 
+    "pos": ["NN", "CC", "JJ", "NNS", "JJ", "CC", "JJ", "IN", "NN"]
+}
+```