Merge pull request #7 from ir-nlp-csui/aksara-v1.3-update-readme

Aksara v1.3 - Update changes info

README.md

@@ -5,6 +5,7 @@ Aksara is an Indonesian NLP tool that conforms to the [Universal Dependencies (U
 * Lemmatization
 * POS tagging
 * Morphological features analysis
+* Dependency Parsing
 
 The output is in the [CoNLL-U format](https://universaldependencies.org/format.html).
 
@@ -32,16 +33,16 @@ Example to process formal Indonesian text:
 foo@bar:~/aksara$ python3 aksara.py -s "Pengeluaran baru ini dipasok oleh rekening bank gemuk Clinton."
 # sent_id = 1
 # text = Pengeluaran baru ini dipasok oleh rekening bank gemuk Clinton.
-1	Pengeluaran	keluar	NOUN	_	Number=Sing	_	_	_	Morf=peN+keluar<VERB>+an_NOUN
-2	baru	baru	ADJ	_	_	_	_	_	Morf=baru<ADJ>_ADJ
-3	ini	ini	DET	_	PronType=Dem	_	_	_	Morf=ini<DET>_DET
-4	dipasok	pasok	VERB	_	Voice=Pass	_	_	_	Morf=di+pasok<VERB>_VERB
-5	oleh	oleh	ADP	_	_	_	_	_	Morf=oleh<ADP>_ADP
-6	rekening	rekening	NOUN	_	Number=Sing	_	_	_	Morf=rekening<NOUN>_NOUN
-7	bank	bank	NOUN	_	Number=Sing	_	_	_	Morf=bank<NOUN>_NOUN
-8	gemuk	gemuk	ADJ	_	_	_	_	_	Morf=gemuk<ADJ>_ADJ
-9	Clinton	Clinton	PROPN	_	_	_	_	_	Morf=Clinton<PROPN>_PROPN
-10	.	.	PUNCT	_	_	_	_	_	Morf=.<PUNCT>_PUNCT
+1	Pengeluaran	keluar	NOUN	_	Number=Sing	4	nsubj	_	Morf=peN+keluar<VERB>+an_NOUN
+2	baru	baru	ADJ	_	_	1	amod	_	Morf=baru<ADJ>_ADJ
+3	ini	ini	DET	_	PronType=Dem	1	det	_	Morf=ini<DET>_DET
+4	dipasok	pasok	VERB	_	Voice=Pass	0	root	_	Morf=di+pasok<VERB>_VERB
+5	oleh	oleh	ADP	_	_	6	case	_	Morf=oleh<ADP>_ADP
+6	rekening	rekening	NOUN	_	Number=Sing	4	obl	_	Morf=rekening<NOUN>_NOUN
+7	bank	bank	NOUN	_	Number=Sing	6	nmod	_	Morf=bank<NOUN>_NOUN
+8	gemuk	gemuk	ADJ	_	_	9	amod	_	Morf=gemuk<ADJ>_ADJ
+9	Clinton	Clinton	PROPN	_	_	6	appos	_	Morf=Clinton<PROPN>_PROPN
+10	.	.	PUNCT	_	_	4	punct	_	Morf=.<PUNCT>_PUNCT
 
 ```
 
@@ -50,14 +51,14 @@ Example to process informal Indonesian text:
 foo@bar:~/aksara$ python3 aksara.py -s "Sering ngikutin gayanya lg nyanyi." --informal
 # sent_id = 1
 # text = Sering ngikutin gayanya lg nyanyi.
-1	Sering	sering	ADV	_	_	_	_	_	Morf=sering<ADV>_ADV
-2	ngikutin	ikut	VERB	_	Polite=Infm|Voice=Act	_	_	_	Morf=NGE+ikut<VERB>+in_VERB
+1	Sering	sering	ADV	_	_	2	advmod	_	Morf=sering<ADV>_ADV
+2	ngikutin	ikut	VERB	_	Polite=Infm|Voice=Act	0	root	_	Morf=NGE+ikut<VERB>+in_VERB
 3-4	gayanya	_	_	_	_	_	_	_	_
-3	gaya	gaya	NOUN	_	Number=Sing	_	_	_	Morf=gaya<NOUN>_NOUN
-4	nya	nya	PRON	_	Number=Sing|Person=3|Poss=Yes|PronType=Prs	_	_	_	Morf=nya<PRON>_PRON
-5	lg	lagi	ADV	_	Abbr=Yes|Polite=Infm	_	_	_	Morf=lagi<ADV>_ADV
-6	nyanyi	nyanyi	VERB	_	_	_	_	_	Morf=nyanyi<VERB>_VERB|SpaceAfter=No
-7	.	.	PUNCT	_	_	_	_	_	Morf=.<PUNCT>_PUNCT
+3	gaya	gaya	NOUN	_	Number=Sing	2	obj	_	Morf=gaya<NOUN>_NOUN
+4	nya	nya	PRON	_	Number=Sing|Person=3|Poss=Yes|PronType=Prs	3	nmod	_	Morf=nya<PRON>_PRON
+5	lg	lagi	ADV	_	Abbr=Yes|Polite=Infm	6	advmod	_	Morf=lagi<ADV>_ADV
+6	nyanyi	nyanyi	VERB	_	Polite=Infm	2	ccomp	_	Morf=nyanyi<VERB>_VERB|SpaceAfter=No
+7	.	.	PUNCT	_	_	6	punct	_	Morf=.<PUNCT>_PUNCT
 
 ```
 
@@ -78,15 +79,26 @@ foo@bar:~/aksara$
 * Use `--lemma` option to get only the output of lemmatization task.
 * Use `--postag` option to get only the output of POS tagging task.
 * Use `--informal` option to use the informal word handler.
+* Use `--model [MODEL_NAME]` option to use which dependency parser machine-learning model. The list below is the name of the model that can be used. 
+  * `FR_GSD-ID_CSUI` (default)
+  * `FR_GSD-ID_GSD`
+  * `IT_ISDT-ID_CSUI`
+  * `IT_ISDT-ID_GSD`
+  * `EN_GUM-ID_CSUI`
+  * `EN_GUM-ID_GSD`
+  * `SL_SSJ-ID_CSUI`
+  * `SL_SSJ-ID_GSD`
 * Please use option `-h` or `--help` for further documentation.
 
 # Acknowledgments
 * Aksara conforms to the annotation guidelines for Indonesian dependency treebank proposed by Alfina et al. (2019) and Alfina et al. (2020)
 * Aksara v1.0 was built by M. Yudistira Hanifmuti and Ika Alfina, as the reseach project for Yudistira's undergraduate thesis at Faculty of Computer Science, Universitas Indonesia in 2020.
 * Aksara v1.1 was built by Muhammad Ridho Ananda and Ika Alfina, as the research project for Ridho's undergraduate thesis at Faculty of Computer Science, Universitas Indonesia in 2021. Aksara v1.1 uses a hybrid POS tagger method of Aksara and Hidden Markov Model (HMM) to do disambiguation.
 * Aksara v1.2 was built by I Made Krisna Dwitama, Muhammad Salman Al Farisi, Ika Alfina, and Arawinda Dinakaramani as the research project for Krisna and Salman undergraduate thesis at Faculty of Computer Science, Universitas Indonesia in 2022. Aksara v1.2 improve the ability of the morphological analyzer in Aksara in order to be able to process informal Indonesian text.
+* Aksara v1.3 was built by Andhika Yusup Maulana, Ika Alfina, and Kurniawati Azizah as the research project for Maulana's undergraduate thesis at the Faculty of Computer Science, Universitas Indonesia, in August 2022. Aksara v1.3 introduces a machine-learning-based dependency parser to fill the 7-8th column that previously left empty.
 
 ## References
+* Andhika Yusup Maulana, Ika Alfina, and Kurniawati Azizah. _**"Building Indonesian Dependency Parser Using Cross-lingual Transfer Learning"**_. In Proceeding of the 2022 International Conference of Asian Language Processing (IALP). _(Accepted)_
 * I Made Krisna Dwitama, Muhammad Salman Al Farisi, Ika Alfina, dan Arawinda Dinakaramani. _**"Building Morphological Analyzer for Informal Text in Indonesian"**_. In Proceeding of the ICACSIS 2022. _(accepted)_ 
 * M. Ridho Ananda, M. Yudistira Hanifmuti, and Ika Alfina. ["**A Hybrid of Rule-based and HMM-based POS Taggers for Indonesian**"](https://ieeexplore.ieee.org/abstract/document/9675180). In Proceeding of the 2021 International Conference of Asian Language Processing (IALP)   
 * M. Yudistira Hanifmuti and Ika Alfina. ["**Aksara: An Indonesian Morphological Analyzer that Conforms to the UD v2 Annotation Guidelines**"](https://ieeexplore.ieee.org/document/9310490). In Proceeding of the 2020 International Conference of Asian Language Processing (IALP)  in Kuala Lumpur, Malaysia, 4-6 Desember 2020.
@@ -95,6 +107,10 @@ foo@bar:~/aksara$
 
 
 # Changelog
+* 2022-10-10 v1.3
+  * added new flag `--model [MODEL_NAME]`
+  * added dependency parser
+  * integrated existing flow with dependency parsing task
 * 2022-08-30 v1.2
   * added informal lexicon, morphotactic rules, and morphophonemic rules
   * added feature Polite=Infm