Changeset 33355 for gs3-extensions/maori-lang-detection/README.txt

Timestamp:

2019-07-24T20:54:50+12:00 (4 years ago)

Author:

ak19

Message:

Changes for adding in the new gen_SentenceDetection_model.sh script, which automates generating a Sentence Detector model for the Maori language, mri-sent_trained.bin, trained on the mri-sent.train file generated by appropritely formatting the 100k Maori sentences file from the opennlp corpus 2011

File:

• gs3-extensions/maori-lang-detection/README.txt (modified) (8 diffs)

gs3-extensions/maori-lang-detection/README.txt

@@ -8 +8 @@
     svn co http://svn.greenstone.org/gs3-extensions/maori-lang-detection
 
-- It contains the OpenNLP that was current at the time of the commit, but you can also get it from its original site http://opennlp.apache.org/download.html
-- The LanguageDetectionModel to be used by OpenNLP is also included (again, current at the time of commit), but you can get it from http://opennlp.apache.org/models.html (direct link: https://www.apache.org/dyn/closer.cgi/opennlp/models/langdetect/1.8.3/langdetect-183.bin)
-
-1. Once you've svn checked it out, create a folder called "models" and put the langdetect-183.bin file into it.
-(This is just a zip file, but has to remain with the .bin extension in order for OpenNLP to use it. If you ever wish to see its contents, you can rename to .zip and use the Archive Manager or other Zip tool to inspect the contents.)
+This checkout contains:
+- tarball of the OpenNLP version that was current at the time of the commit, but you can also get it from its original site http://opennlp.apache.org/download.html
+- the folder "models-trainingdata-and-sampletxts", itself containing:
+    - langdetect-183.bin: The LanguageDetectionModel to be used by OpenNLP is also included (again, current at the time of commit), but you can get it from http://opennlp.apache.org/models.html (direct link: https://www.apache.org/dyn/closer.cgi/opennlp/models/langdetect/1.8.3/langdetect-183.bin)
+    - mri-sent_trained.bin: our own custom generated model for Maori Sentence Detection
+    - mri-sent.train: the training text file for generating the mri-sent_trained.bin Maori Sentence Detection model
+    - sample_mri_paragraphs.txt: contains some text to test the Maori Sentence Detection model on. Its content is from Niupepa collection page http://www.nzdl.org/cgi-bin/library?gg=text&e=p-00000-00---off-0niupepa--00-0----0-10-0---0---0direct-10---4-------0-1l--11-en-50---20-about---00-0-1-00-0-0-11-1-0utfZz-8-00&a=p&p=about&l=mi&nw=utf-8)
+    - sample_maori_shorttext.txt: to test the MaoriTextDetector.java with
+- "src" folder for Java classes, currently just MaoriTextDetector.java and its classfile. MaoriTextDetector.java uses the aforementioned LanguageDetectionModel, langdetect-183.bin, to detect whether input text from a file or stdin is in Maori or not
+- gen_SentenceDetection_model.sh, our custom script that generates both the mri-sent.train and model mri-sent_trained.bin files mentioned above
+    - the script works on opennlp's leipzig corpus of 100k Maori sentences from 2011 to get its sample sentences into the correct format in the mri-sent.train file
+    - from this file containing training sentences, it generates the Sentence Detector Model, mri-sent_trained.bin
+- mri-opennlp-corpus.tar.gz: a tarball containing the 100k Maori sentences opennlp corpus checked out with svn in its original directory structure from https://svn.apache.org/repos/bigdata/opennlp/trunk/mri_web_2011_100K-sentences.txt
+
+
+1. Once you've svn checked out the maori-lang-detection from gs3-extensions, create a folder called "models" and put the files langdetect-183.bin and mri-sent_trained.bin from the folder "models-trainingdata-and-sampletxts" into it.
+(These are just zip files, but have to remain with the .bin extension in order for OpenNLP to use them. If you ever wish to see the contents of such a .bin file, you can rename to .zip and use the Archive Manager or other Zip tool to inspect the contents.)
+
+You can optionally put the file models-trainingdata-and-sampletxts/
+
 
 2. Next extract the apache-opennlp-1.9.1-bin.tar.gz.
 This will create a folder called apache-opennlp-1.9.1. Move the "models" folder you created in step 1 into this folder.
+
 
 3. Before you can compile or run the MaoriTextDetector program, you always have to prepare a terminal by setting up the environment for OpenNLP as follows:
@@ -25 +41 @@
 Still in the SAME terminal as where you set up the OPENNLP_HOME environment in step 3, you can now run:
       maori-lang-detection/src$ javac -cp ".:$OPENNLP_HOME/lib/opennlp-tools-1.9.1.jar" MaoriTextDetector.java
+
 
 5. To run the MaoriTextDetector program, you will need the JDK or JRE 7+ bin folder on your PATH and still in the SAME terminal as where you set up the OPENNLP_HOME environment in step 3,
@@ -109 +126 @@
 I got the binary version. I unzipped it.
 
+
 2. Get the model, langdetect-183.bin, from: http://opennlp.apache.org/models.html
     Direct download link: https://www.apache.org/dyn/closer.cgi/opennlp/models/langdetect/1.8.3/langdetect-183.bin
@@ -116 +134 @@
 - But for using with openNLP, don't rename or unzip it.
 
+
 3. UNNECESSARY:
 I started by following the instructions at the botton of: 
@@ -135 +154 @@
 
 
-    svn co https://svn.apache.org/repos/bigdata/opennlp/trunk --depth immediates
-    mv trunk opennlp-corpus
-    svn up --set-depth immediates
+    svn co --depth immediates --trust-server-cert --non-interactive https://svn.apache.org/repos/bigdata/opennlp/trunk opennlp-corpus
+    cd opennlp-corpus
+    svn up --set-depth immediates --trust-server-cert --non-interactive
+    cd leipzig
+    svn up --set-depth immediates --trust-server-cert --non-interactive
     cd resources/
-    wharariki:[197]/Scratch/ak19/openNLP-lang-detect/opennlp-corpus/leipzig/resources>svn up --set-depth infinity
+    wharariki:[197]/Scratch/ak19/openNLP-lang-detect/opennlp-corpus/leipzig/resources>svn up --set-depth infinity --trust-server-cert --non-interactive
     cd ../data
-    svn up mri_web_2011_100K-sentences.txt
+    svn up --trust-server-cert --non-interactive mri_web_2011_100K-sentences.txt
+    
+    (# UNNECESSARY TO DOWNLOAD:
     svn up eng_wikipedia_2012_3M-sentences.txt
     svn up nld_mixed_2012_1M-sentences.txt
     svn up fra_mixed_2009_1M-sentences.txt
+    )
 
     cd ..
@@ -157 +181 @@
 
 
-4. Attempting running OpenNLP + LanguageDetectorModel's command line tools for language prediction
+4. Attempting to run OpenNLP + LanguageDetectorModel's command line tools for language prediction
 
 I couldn't get prediction to work from the command line, so I ended up writing that part as a Java class. But I could run some part of the command line tools with the instructions on the following pages. 
@@ -184 +208 @@
 
 
+UPDATE 24 July 2019: The following worked
+    >$OPENNLP_HOME/bin/opennlp LanguageDetector $OPENNLP_HOME/models/langdetect-183.bin < opennlp-corpus/leipzig/data/mri_web_2011_100K-sentences.txt 
+but it doesn't provide predictions. Not sure I understand what it did other than print the contents of the *sentences.txt file and end with:
+        ...
+        Average: 0.1 doc/s 
+        Total: 1 doc
+        Runtime: 8.046s
+        Execution time: 8.719 seconds
+
+
 5. For writing Java code:
 To write the basic code, I followed the Java skeleton examples at
@@ -210 +244 @@
 
 (Though possibly the only jar file needed in $OPENNLP_HOME/lib is opennlp-tools-1.9.1.jar) 
+
+================
+
+UNORGANISED
+
+https://www.slideshare.net/shuyo/short-text-language-detection-with-infinitygram-12949447
+http://alexott.blogspot.com/2017/10/evaluating-fasttexts-models-for.html
+
+http://opennlp.apache.org/docs/1.9.1/manual/opennlp.html#tools.cli.sentdetect
+
+SentenceDetectorTrainer example
+https://www.tutorialkart.com/opennlp/train-model-sentence-detection-java/
+
+https://stackoverflow.com/questions/36516363/sentence-detection-with-opennlp