-
Notifications
You must be signed in to change notification settings - Fork 49
/
Copy pathopennlp.html
12326 lines (11227 loc) · 429 KB
/
opennlp.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Apache OpenNLP Developer Documentation</title>
<link rel="stylesheet" href="css/opennlp-docs.css" type="text/css">
<meta name="generator" content="DocBook XSL-NS Stylesheets V1.75.2">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div lang="en" class="book" title="Apache OpenNLP Developer Documentation">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="d4e1"></a>Apache OpenNLP Developer Documentation</h1>
</div>
<div>
<div class="authorgroup">
<h3 class="corpauthor">Written and maintained by the Apache OpenNLP Development
Community</h3>
</div>
</div>
<div>
<p class="releaseinfo">
Version 1.9.1
</p>
</div>
<div>
<p class="copyright">Copyright © 2011, 2014 The Apache Software Foundation</p>
</div>
<div>
<div class="legalnotice" title="Legal Notice"><a name="d4e7"></a>
<p title="License and Disclaimer">
<b>License and Disclaimer. </b>
The ASF licenses this documentation
to you under the Apache License,
Version 2.0 (the
"License"); you may not use this documentation
except in compliance
with the License. You may obtain a copy of the
License at
</p>
<div class="blockquote">
<blockquote class="blockquote">
<p>
<a class="ulink" href="http://www.apache.org/licenses/LICENSE-2.0"
target="_top">http://www.apache.org/licenses/LICENSE-2.0</a>
</p>
</blockquote>
</div>
<p title="License and Disclaimer">
Unless required by applicable law or agreed to in writing,
this documentation and its contents are distributed under the License
on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
</p>
</div>
</div>
</div>
<hr>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="chapter"><a href="#opennlp">1. Introduction</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#intro.description">Description</a></span></dt>
<dt><span class="section"><a href="#intro.general.library.structure">General Library
Structure</a></span></dt>
<dt><span class="section"><a href="#intro.api">Application Program Interface (API). Generic
Example</a></span></dt>
<dt><span class="section"><a href="#intro.cli">Command line interface (CLI)</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#intro.cli.description">Description</a></span></dt>
<dt><span class="section"><a href="#intro.cli.toolslist">List of tools</a></span></dt>
<dt><span class="section"><a href="#intro.cli.setup">Setting up</a></span></dt>
<dt><span class="section"><a href="#intro.cli.generic">Generic Example</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.langdetect">2. Language Detector</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.langdetect.classifying">Classifying</a></span></dt>
<dt><span class="section"><a href="#tools.langdetect.classifying.cmdline">Language Detector
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.langdetect.classifying.api">Language Detector
API</a></span></dt>
<dt><span class="section"><a href="#tools.langdetect.training">Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.langdetect.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.langdetect.training.leipzig">Training with
Leipzig</a></span></dt>
<dt><span class="section"><a href="#tools.langdetect.training.api">Training
API</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.sentdetect">3. Sentence Detector</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.sentdetect.detection">Sentence Detection</a></span>
</dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.sentdetect.detection.cmdline">Sentence
Detection Tool</a></span></dt>
<dt><span class="section"><a href="#tools.sentdetect.detection.api">Sentence Detection
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.sentdetect.training">Sentence Detector
Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.sentdetect.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.sentdetect.training.api">Training
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.sentdetect.eval">Evaluation</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.sentdetect.eval.tool">Evaluation
Tool</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.tokenizer">4. Tokenizer</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.tokenizer.introduction">Tokenization</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.tokenizer.cmdline">Tokenizer Tools</a></span>
</dt>
<dt><span class="section"><a href="#tools.tokenizer.api">Tokenizer API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.tokenizer.training">Tokenizer Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.tokenizer.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.tokenizer.training.api">Training
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.tokenizer.detokenizing">Detokenizing</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.tokenizer.detokenizing.api">Detokenizing
API</a></span></dt>
<dt><span class="section"><a href="#tools.tokenizer.detokenizing.dict">Detokenizer
Dictionary</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.namefind">5. Name Finder</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.namefind.recognition">Named Entity
Recognition</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.namefind.recognition.cmdline">Name Finder
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.namefind.recognition.api">Name Finder
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.namefind.training">Name Finder Training</a></span>
</dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.namefind.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.namefind.training.api">Training API</a></span>
</dt>
<dt><span class="section"><a href="#tools.namefind.training.featuregen">Custom Feature
Generation</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.namefind.eval">Evaluation</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.namefind.eval.tool">Evaluation Tool</a></span>
</dt>
<dt><span class="section"><a href="#tools.namefind.eval.api">Evaluation API</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.namefind.annotation_guides">Named Entity Annotation
Guidelines</a></span></dt>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.doccat">6. Document Categorizer</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.doccat.classifying">Classifying</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.doccat.classifying.cmdline">Document
Categorizer Tool</a></span></dt>
<dt><span class="section"><a href="#tools.doccat.classifying.api">Document Categorizer
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.doccat.training">Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.doccat.training.tool">Training Tool</a></span>
</dt>
<dt><span class="section"><a href="#tools.doccat.training.api">Training API</a></span>
</dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.postagger">7. Part-of-Speech Tagger</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.postagger.tagging">Tagging</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.postagger.tagging.cmdline">POS Tagger
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.postagger.tagging.api">POS Tagger
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.postagger.training">Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.postagger.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.postagger.training.api">Training
API</a></span></dt>
<dt><span class="section"><a href="#tools.postagger.training.tagdict">Tag
Dictionary</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.postagger.eval">Evaluation</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.postagger.eval.tool">Evaluation
Tool</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.lemmatizer">8. Lemmatizer</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.lemmatizer.tagging.cmdline">Lemmatizer Tool</a></span>
</dt>
<dt><span class="section"><a href="#tools.lemmatizer.tagging.api">Lemmatizer API</a></span></dt>
<dt><span class="section"><a href="#tools.lemmatizer.training">Lemmatizer Training</a></span>
</dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.lemmatizer.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.lemmatizer.training.api">Training
API</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.lemmatizer.evaluation">Lemmatizer
Evaluation</a></span></dt>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.chunker">9. Chunker</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.chunking">Chunking</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.chunking.cmdline">Chunker
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.parser.chunking.api">Chunking API</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.chunker.training">Chunker Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.chunker.training.tool">Training
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.chunker.training.api">Training API</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.chunker.evaluation">Chunker Evaluation</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.chunker.evaluation.tool">Chunker Evaluation
Tool</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.parser">10. Parser</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.parsing">Parsing</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.parsing.cmdline">Parser Tool</a></span>
</dt>
<dt><span class="section"><a href="#tools.parser.parsing.api">Parsing API</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.parser.training">Parser Training</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.training.tool">Training Tool</a></span>
</dt>
<dt><span class="section"><a href="#tools.parser.training.api">Training API</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.parser.evaluation">Parser Evaluation</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.parser.evaluation.tool">Parser Evaluation
Tool</a></span></dt>
<dt><span class="section"><a href="#tools.parser.evaluation.api">Evaluation
API</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.coref">11. Coreference Resolution</a></span></dt>
<dt><span class="chapter"><a href="#tools.extension">12. Extending OpenNLP</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.extension.writing">Writing an extension</a></span>
</dt>
<dt><span class="section"><a href="#tools.extension.osgi">Running in an OSGi
container</a></span></dt>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.corpora">13. Corpora</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.corpora.conll">CONLL</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.corpora.conll.2000">CONLL 2000</a></span></dt>
<dt><span class="section"><a href="#tools.corpora.conll.2002">CONLL 2002</a></span></dt>
<dt><span class="section"><a href="#tools.corpora.conll.2003">CONLL 2003</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.corpora.arvores-deitadas">Arvores Deitadas</a></span>
</dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.corpora.arvores-deitadas.getting">Getting the
data</a></span></dt>
<dt><span class="section"><a
href="#tools.corpora.arvores-deitadas.converting">Converting the data
(optional)</a></span></dt>
<dt><span class="section"><a href="#tools.corpora.arvores-deitadas.evaluation">Training
and Evaluation</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.corpora.ontonotes">OntoNotes Release 4.0</a></span>
</dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.corpora.ontonotes.namefinder">Name Finder
Training</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.corpora.brat">Brat Format Support</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.corpora.brat.webtool">Sentences and
Tokens</a></span></dt>
<dt><span class="section"><a href="#tools.corpora.brat.training">Training</a></span>
</dt>
<dt><span class="section"><a href="#tools.corpora.brat.evaluation">Evaluation</a></span>
</dt>
<dt><span class="section"><a href="#tools.corpora.brat.cross-validation">Cross
Validation</a></span></dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#opennlp.ml">14. Machine Learning</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#opennlp.ml.maxent">Maximum Entropy</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#opennlp.ml.maxent.impl">Implementation</a></span>
</dt>
</dl>
</dd>
</dl>
</dd>
<dt><span class="chapter"><a href="#org.apche.opennlp.uima">15. UIMA Integration</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#org.apche.opennlp.running-pear-sample">Running the pear
sample in CVD</a></span></dt>
<dt><span class="section"><a href="#org.apche.opennlp.further-help">Further Help</a></span></dt>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.morfologik-addon">16. Morfologik Addon</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.morfologik-addon.api">Morfologik
Integration</a></span></dt>
<dt><span class="section"><a href="#tools.morfologik-addon.cmdline">Morfologik CLI
Tools</a></span></dt>
</dl>
</dd>
<dt><span class="chapter"><a href="#tools.cli">17. The Command Line Interface</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.cli.doccat">Doccat</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.cli.doccat.Doccat">Doccat</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.doccat.DoccatTrainer">DoccatTrainer</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.doccat.DoccatEvaluator">DoccatEvaluator</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.doccat.DoccatCrossValidator">DoccatCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.doccat.DoccatConverter">DoccatConverter</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.langdetect">Langdetect</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.langdetect.LanguageDetector">LanguageDetector</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.langdetect.LanguageDetectorTrainer">LanguageDetectorTrainer</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.langdetect.LanguageDetectorConverter">LanguageDetectorConverter</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.langdetect.LanguageDetectorCrossValidator">LanguageDetectorCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.langdetect.LanguageDetectorEvaluator">LanguageDetectorEvaluator</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.dictionary">Dictionary</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.dictionary.DictionaryBuilder">DictionaryBuilder</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.tokenizer">Tokenizer</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.tokenizer.SimpleTokenizer">SimpleTokenizer</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.TokenizerME">TokenizerME</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.TokenizerTrainer">TokenizerTrainer</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.TokenizerMEEvaluator">TokenizerMEEvaluator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.TokenizerCrossValidator">TokenizerCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.TokenizerConverter">TokenizerConverter</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.tokenizer.DictionaryDetokenizer">DictionaryDetokenizer</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.sentdetect">Sentdetect</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.sentdetect.SentenceDetector">SentenceDetector</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.sentdetect.SentenceDetectorTrainer">SentenceDetectorTrainer</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.sentdetect.SentenceDetectorEvaluator">SentenceDetectorEvaluator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.sentdetect.SentenceDetectorCrossValidator">SentenceDetectorCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.sentdetect.SentenceDetectorConverter">SentenceDetectorConverter</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.namefind">Namefind</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.namefind.TokenNameFinder">TokenNameFinder</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.namefind.TokenNameFinderTrainer">TokenNameFinderTrainer</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.namefind.TokenNameFinderEvaluator">TokenNameFinderEvaluator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.namefind.TokenNameFinderCrossValidator">TokenNameFinderCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.namefind.TokenNameFinderConverter">TokenNameFinderConverter</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.namefind.CensusDictionaryCreator">CensusDictionaryCreator</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.postag">Postag</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.cli.postag.POSTagger">POSTagger</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.postag.POSTaggerTrainer">POSTaggerTrainer</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.postag.POSTaggerEvaluator">POSTaggerEvaluator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.postag.POSTaggerCrossValidator">POSTaggerCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.postag.POSTaggerConverter">POSTaggerConverter</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.lemmatizer">Lemmatizer</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.lemmatizer.LemmatizerME">LemmatizerME</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.lemmatizer.LemmatizerTrainerME">LemmatizerTrainerME</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.lemmatizer.LemmatizerEvaluator">LemmatizerEvaluator</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.chunker">Chunker</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.cli.chunker.ChunkerME">ChunkerME</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.chunker.ChunkerTrainerME">ChunkerTrainerME</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.chunker.ChunkerEvaluator">ChunkerEvaluator</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.chunker.ChunkerCrossValidator">ChunkerCrossValidator</a></span>
</dt>
<dt><span class="section"><a
href="#tools.cli.chunker.ChunkerConverter">ChunkerConverter</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.parser">Parser</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#tools.cli.parser.Parser">Parser</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.ParserTrainer">ParserTrainer</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.ParserEvaluator">ParserEvaluator</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.ParserConverter">ParserConverter</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.BuildModelUpdater">BuildModelUpdater</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.CheckModelUpdater">CheckModelUpdater</a></span></dt>
<dt><span class="section"><a
href="#tools.cli.parser.TaggerModelReplacer">TaggerModelReplacer</a></span>
</dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.entitylinker">Entitylinker</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.entitylinker.EntityLinker">EntityLinker</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#tools.cli.languagemodel">Languagemodel</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a
href="#tools.cli.languagemodel.NGramLanguageModel">NGramLanguageModel</a></span>
</dt>
</dl>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="list-of-tables">
<p><b>List of Tables</b></p>
<dl>
<dt>2.1. <a href="#d4e85">Normalizers</a></dt>
<dt>5.1. <a href="#d4e339">Feature Generators</a></dt>
</dl>
</div>
<div class="chapter" title="Chapter 1. Introduction">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a name="opennlp"></a>Chapter 1. Introduction</h2>
</div>
</div>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="#intro.description">Description</a></span></dt>
<dt><span class="section"><a href="#intro.general.library.structure">General Library
Structure</a></span></dt>
<dt><span class="section"><a href="#intro.api">Application Program Interface (API). Generic
Example</a></span></dt>
<dt><span class="section"><a href="#intro.cli">Command line interface (CLI)</a></span></dt>
<dd>
<dl>
<dt><span class="section"><a href="#intro.cli.description">Description</a></span></dt>
<dt><span class="section"><a href="#intro.cli.toolslist">List of tools</a></span></dt>
<dt><span class="section"><a href="#intro.cli.setup">Setting up</a></span></dt>
<dt><span class="section"><a href="#intro.cli.generic">Generic Example</a></span></dt>
</dl>
</dd>
</dl>
</div>
<div class="section" title="Description">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name="intro.description"></a>Description</h2>
</div>
</div>
</div>
<p>
The Apache OpenNLP library is a machine learning based toolkit for the processing of natural
language text.
It supports the most common NLP tasks, such as tokenization, sentence segmentation,
part-of-speech tagging, named entity extraction, chunking, parsing, and coreference resolution.
These tasks are usually required to build more advanced text processing services.
OpenNLP also included maximum entropy and perceptron based machine learning.
</p>
<p>
The goal of the OpenNLP project will be to create a mature toolkit for the abovementioned tasks.
An additional goal is to provide a large number of pre-built models for a variety of languages, as
well as the annotated text resources that those models are derived from.
</p>
</div>
<div class="section" title="General Library Structure">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name="intro.general.library.structure"></a>General
Library Structure</h2>
</div>
</div>
</div>
<p>The Apache OpenNLP library contains several components, enabling one to build
a full natural language processing pipeline. These components
include: sentence detector, tokenizer,
name finder, document categorizer, part-of-speech tagger, chunker, parser,
coreference resolution. Components contain parts which enable one to execute the
respective natural language processing task, to train a model and often also to evaluate a
model. Each of these facilities is accessible via its application program
interface (API). In addition, a command line interface (CLI) is provided for convenience
of experiments and training.
</p>
</div>
<div class="section" title="Application Program Interface (API). Generic Example">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name="intro.api"></a>Application Program Interface
(API). Generic Example</h2>
</div>
</div>
</div>
<p>
OpenNLP components have similar APIs. Normally, to execute a task,
one should provide a model and an input.
</p>
<p>
A model is usually loaded by providing a FileInputStream with a model to a
constructor of the model class:
</p>
<pre class="programlisting">
<b class="hl-keyword">try</b> (InputStream modelIn = <b class="hl-keyword">new</b> FileInputStream(<b class="hl-string"><i style="color:red">"lang-model-name.bin"</i></b>)) {
SomeModel model = <b class="hl-keyword">new</b> SomeModel(modelIn);
}
</pre>
<p>
</p>
<p>
After the model is loaded the tool itself can be instantiated.
</p>
<pre class="programlisting">
ToolName toolName = <b class="hl-keyword">new</b> ToolName(model);
</pre>
<p>
After the tool is instantiated, the processing task can be executed. The input and the
output formats are specific to the tool, but often the output is an array of String,
and the input is a String or an array of String.
</p>
<pre class="programlisting">
String output[] = toolName.executeTask(<b class="hl-string"><i style="color:red">"This is a sample text."</i></b>);
</pre>
<p>
</p>
</div>
<div class="section" title="Command line interface (CLI)">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name="intro.cli"></a>Command line interface (CLI)
</h2>
</div>
</div>
</div>
<div class="section" title="Description">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="intro.cli.description"></a>Description</h3>
</div>
</div>
</div>
<p>
OpenNLP provides a command line script, serving as a unique entry point to all
included tools. The script is located in the bin directory of OpenNLP binary
distribution. Included are versions for Windows: opennlp.bat and Linux or
compatible systems: opennlp.
</p>
</div>
<div class="section" title="List of tools">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="intro.cli.toolslist"></a>List of tools</h3>
</div>
</div>
</div>
<p>
The list of command line tools for Apache OpenNLP 1.9.1,
as well as a description of its arguments, is available at section <a class="xref"
href="#tools.cli" title="Chapter 17. The Command Line Interface">Chapter 17,
<i>The Command Line Interface</i></a>.
</p>
</div>
<div class="section" title="Setting up">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="intro.cli.setup"></a>Setting up</h3>
</div>
</div>
</div>
<p>
OpenNLP script uses JAVA_CMD and JAVA_HOME variables to determine which command to
use to execute Java virtual machine.
</p>
<p>
OpenNLP script uses OPENNLP_HOME variable to determine the location of the binary
distribution of OpenNLP. It is recommended to point this variable to the binary
distribution of current OpenNLP version and update PATH variable to include
$OPENNLP_HOME/bin or %OPENNLP_HOME%\bin.
</p>
<p>
Such configuration allows calling OpenNLP conveniently. Examples below
suppose this configuration has been done.
</p>
</div>
<div class="section" title="Generic Example">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="intro.cli.generic"></a>Generic Example</h3>
</div>
</div>
</div>
<p>
Apache OpenNLP provides a common command line script to access all its tools:
</p>
<pre class="screen">
$ opennlp
</pre>
<p>
This script prints current version of the library and lists all available tools:
</p>
<pre class="screen">
OpenNLP <VERSION>. Usage: opennlp TOOL
where TOOL is one of:
Doccat learnable document categorizer
DoccatTrainer trainer for the learnable document categorizer
DoccatConverter converts leipzig data format to native OpenNLP format
DictionaryBuilder builds a new dictionary
SimpleTokenizer character class tokenizer
TokenizerME learnable tokenizer
TokenizerTrainer trainer for the learnable tokenizer
TokenizerMEEvaluator evaluator for the learnable tokenizer
TokenizerCrossValidator K-fold cross validator for the learnable tokenizer
TokenizerConverter converts foreign data formats (namefinder,conllx,pos) to native OpenNLP format
DictionaryDetokenizer
SentenceDetector learnable sentence detector
SentenceDetectorTrainer trainer for the learnable sentence detector
SentenceDetectorEvaluator evaluator for the learnable sentence detector
SentenceDetectorCrossValidator K-fold cross validator for the learnable sentence detector
SentenceDetectorConverter converts foreign data formats (namefinder,conllx,pos) to native OpenNLP format
TokenNameFinder learnable name finder
TokenNameFinderTrainer trainer for the learnable name finder
TokenNameFinderEvaluator Measures the performance of the NameFinder model with the reference data
TokenNameFinderCrossValidator K-fold cross validator for the learnable Name Finder
TokenNameFinderConverter converts foreign data formats (bionlp2004,conll03,conll02,ad) to native OpenNLP format
CensusDictionaryCreator Converts 1990 US Census names into a dictionary
POSTagger learnable part of speech tagger
POSTaggerTrainer trains a model for the part-of-speech tagger
POSTaggerEvaluator Measures the performance of the POS tagger model with the reference data
POSTaggerCrossValidator K-fold cross validator for the learnable POS tagger
POSTaggerConverter converts conllx data format to native OpenNLP format
ChunkerME learnable chunker
ChunkerTrainerME trainer for the learnable chunker
ChunkerEvaluator Measures the performance of the Chunker model with the reference data
ChunkerCrossValidator K-fold cross validator for the chunker
ChunkerConverter converts ad data format to native OpenNLP format
Parser performs full syntactic parsing
ParserTrainer trains the learnable parser
ParserEvaluator Measures the performance of the Parser model with the reference data
BuildModelUpdater trains and updates the build model in a parser model
CheckModelUpdater trains and updates the check model in a parser model
TaggerModelReplacer replaces the tagger model in a parser model
All tools print help when invoked with help parameter
Example: opennlp SimpleTokenizer help
</pre>
<p>
</p>
<p>OpenNLP tools have similar command line structure and options. To discover tool
options, run it with no parameters:
</p>
<pre class="screen">
$ opennlp ToolName
</pre>
<p>
The tool will output two blocks of help.
</p>
<p>
The first block describes the general structure of this tool command line:
</p>
<pre class="screen">
Usage: opennlp TokenizerTrainer[.namefinder|.conllx|.pos] [-abbDict path] ... -model modelFile ...
</pre>
<p>
The general structure of this tool command line includes the obligatory tool name
(TokenizerTrainer), the optional format parameters ([.namefinder|.conllx|.pos]),
the optional parameters ([-abbDict path] ...), and the obligatory parameters
(-model modelFile ...).
</p>
<p>
The format parameters enable direct processing of non-native data without conversion.
Each format might have its own parameters, which are displayed if the tool is
executed without or with help parameter:
</p>
<pre class="screen">
$ opennlp TokenizerTrainer.conllx help
</pre>
<p>
</p>
<pre class="screen">
Usage: opennlp TokenizerTrainer.conllx [-abbDict path] [-alphaNumOpt isAlphaNumOpt] ...
Arguments description:
-abbDict path
abbreviation dictionary in XML format.
...
</pre>
<p>
To switch the tool to a specific format, add a dot and the format name after
the tool name:
</p>
<pre class="screen">
$ opennlp TokenizerTrainer.conllx -model en-pos.bin ...
</pre>
<p>
</p>
<p>
The second block of the help message describes the individual arguments:
</p>
<pre class="screen">
Arguments description:
-type maxent|perceptron|perceptron_sequence
The type of the token name finder model. One of maxent|perceptron|perceptron_sequence.
-dict dictionaryPath
The XML tag dictionary file
...
</pre>
<p>
</p>
<p>
Most tools for processing need to be provided at least a model:
</p>
<pre class="screen">
$ opennlp ToolName lang-model-name.bin
</pre>
<p>
When tool is executed this way, the model is loaded and the tool is waiting for
the input from standard input. This input is processed and printed to standard
output.
</p>
<p>Alternative, or one should say, most commonly used way is to use console input and
output redirection options to provide also an input and an output files:
</p>
<pre class="screen">
$ opennlp ToolName lang-model-name.bin < input.txt > output.txt
</pre>
<p>
</p>
<p>
Most tools for model training need to be provided first a model name,
optionally some training options (such as model type, number of iterations),
and then the data.
</p>
<p>
A model name is just a file name.
</p>
<p>
Training options often include number of iterations, cutoff,