Update README.md

README.md

@@ -60,9 +60,18 @@ A sample instance from the dataset:
 {
 	'id_doc': 'solar1', 
 	'doc_title': 'KUS-G-slo-1-GO-E-2009-10001', 
-	'is_manually_validated': True,   
-	'src_tokens': ['”', 'Ne', 'da', 'sovražim', ',', 'da', 'ljubim', 'sem', 'na', 'svetu', '”', ',', 'izreče', 'Antigona', 'v', 'bran', 'kralju', 'Kreonu', 'za', 'svoje', 'nasprotno', 'mišljenje', 'pred', 'smrtjo', '.'],
-	'tgt_tokens': ['„', 'Ne', 'da', 'sovražim', ',', 'da', 'ljubim', 'sem', 'na', 'svetu', ',', '”', 'izreče', 'Antigona', 'sebi', 'v', 'bran', 'kralju', 'Kreonu', 'za', 'svoje', 'nasprotno', 'mišljenje', 'pred', 'smrtjo', '.'],
+	'is_manually_validated': True, 
+	'src_tokens': ['”', 'Ne', 'da', 'sovražim', ',', 'da', 'ljubim', 'sem', 'na', 'svetu', '”', ',', 'izreče', 'Antigona', 'v', 'bran', 'kralju', 'Kreonu', 'za', 'svoje', 'nasprotno', 'mišljenje', 'pred', 'smrtjo', '.'], 
+	'src_ling_annotations': {
+		# truncated for conciseness
+		'lemma': ['”', 'ne', 'da', 'sovražiti', ...], 
+		'ana': ['mte:U', 'mte:L', 'mte:Vd', ...],		
+		'msd': ['UPosTag=PUNCT', 'UPosTag=PART|Polarity=Neg', 'UPosTag=SCONJ', ...], 
+		'ne_tag': [..., 'O', 'B-PER', 'O', ...]
+	}, 
+	'tgt_tokens': ['„', 'Ne', 'da', 'sovražim', ',', 'da', 'ljubim', 'sem', 'na', 'svetu', ',', '”', 'izreče', 'Antigona', 'sebi', 'v', 'bran', 'kralju', 'Kreonu', 'za', 'svoje', 'nasprotno', 'mišljenje', 'pred', 'smrtjo', '.'], 
+	# omitted for conciseness, the format is the same as in 'src_ling_annotations'
+	'tgt_ling_annotations': {...}, 
 	'corrections': [
 		{'idx_src': [0], 'idx_tgt': [0], 'corr_types': ['Z/LOČ/nerazvrščeno']}, 
 		{'idx_src': [10, 11], 'idx_tgt': [10, 11], 'corr_types': ['Z/LOČ/nerazvrščeno']}, 
@@ -81,8 +90,10 @@ The instance represents a correction in the document 'solar1' (`id_doc`), which
 - `id_doc`: a string containing the identifying name of the document in which the sentence appears;  
 - `doc_title`: a string containing the assigned document title;  
 - `is_manually_validated`: a bool indicating whether the document in which the sentence appears was reviewed by a teacher;   
-- `src_tokens`: words in the source sentence (`[]` if there is no source sentence);
+- `src_tokens`: words in the source sentence (`[]` if there is no source sentence);  
+- `src_ling_annotations`: a dict containing the lemmas (key `"lemma"`), morphosyntactic descriptions using UD (key `"msd"`) and JOS/MULTEXT-East (key `"ana"`) specification, and named entity tags encoded using IOB2 (key `"ne_tag"`) for the source tokens;   
 - `tgt_tokens`: words in the target sentence (`[]` if there is no target sentence);  
+- `tgt_ling_annotations`: a dict containing the lemmas (key `"lemma"`), morphosyntactic descriptions using UD (key `"msd"`) and JOS/MULTEXT-East (key `"ana"`) specification, and named entity tags encoded using IOB2 (key `"ne_tag"`) for the target tokens;
 - `corrections`: a list of the corrections, with each correction represented with a dictionary, containing the indices of the source tokens involved (`idx_src`), target tokens involved (`idx_tgt`), and the categories of the corrections made (`corr_types`). Please note that there can be multiple assigned categories for one annotated correction, in which case `len(corr_types) > 1`.