You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opennlp.apache.org by jo...@apache.org on 2011/02/01 11:00:35 UTC
svn commit: r1065969 - in /incubator/opennlp/trunk/opennlp-docs/src/docbkx:
opennlp.xml uima-integration.xml
Author: joern
Date: Tue Feb 1 10:00:35 2011
New Revision: 1065969
URL: http://svn.apache.org/viewvc?rev=1065969&view=rev
Log:
OPENNLP-49 Moved first part of UIMA Integration documentation over from old SourceForge project. And added it to the book, also added the doccat and coref chapters with this commit.
Added:
incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml (with props)
Modified:
incubator/opennlp/trunk/opennlp-docs/src/docbkx/opennlp.xml
Modified: incubator/opennlp/trunk/opennlp-docs/src/docbkx/opennlp.xml
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-docs/src/docbkx/opennlp.xml?rev=1065969&r1=1065968&r2=1065969&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-docs/src/docbkx/opennlp.xml (original)
+++ incubator/opennlp/trunk/opennlp-docs/src/docbkx/opennlp.xml Tue Feb 1 10:00:35 2011
@@ -79,10 +79,12 @@ under the License.
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./sentdetect.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./tokenizer.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./namefinder.xml" />
- <!--xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./doccat.xml" /-->
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./doccat.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./postagger.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./chunker.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./parser.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./coref.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./corpora.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./machine-learning.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="./uima-integration.xml" />
</book>
Added: incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml?rev=1065969&view=auto
==============================================================================
--- incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml (added)
+++ incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml Tue Feb 1 10:00:35 2011
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"[
+]>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed 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.
+-->
+
+<chapter id="org.apche.opennlp.uima">
+<title>UIMA Integration</title>
+<para>
+ The UIMA Integration wraps the OpenNLP components in UIMA Analysis Engines which can
+ be used to automatically annotate text and train new OpenNLP models from annotated text.
+</para>
+ <section id="org.apche.opennlp.running-pear-sample">
+ <title>Running the pear sample in CVD</title>
+ <para>
+ The Cas Visual Debugger is shipped as part of the UIMA distribution and is a tool which can run
+ the OpenNLP UIMA Annotators and display their analysis results. The source distribution comes with a script
+ which can create a sample UIMA application. Which includes the sentence detector, tokenizer,
+ pos tagger, chunker and name finders for English. This sample application is packaged in the
+ pear format and must be installed with the pear installer before it can be run by CVD.
+ Please consult the UIMA documentation for further information about the pear installer.
+ </para>
+ <para>
+ The OpenNLP UIMA pear file must be build manually.
+ First download the source distribution, unzip it and go to the apache-opennlp/opennlp folder.
+ Type "mvn install" to build everything. Now build the pear file, go to apache-opennlp/opennlp-uima
+ and build it as shown below. Note the models will be downloaded
+ from the old SourceForge repository and are not licensed under the AL 2.0.
+ <screen>
+ <![CDATA[
+$ ant -f createPear.xml
+Buildfile: createPear.xml
+
+createPear:
+ [echo] ##### Creating OpenNlpTextAnalyzer pear #####
+ [copy] Copying 13 files to OpenNlpTextAnalyzer/desc
+ [copy] Copying 1 file to OpenNlpTextAnalyzer/metadata
+ [copy] Copying 1 file to OpenNlpTextAnalyzer/lib
+ [copy] Copying 3 files to OpenNlpTextAnalyzer/lib
+ [mkdir] Created dir: OpenNlpTextAnalyzer/models
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-token.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-token.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-sent.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-sent.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-date.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-date.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-location.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-location.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-money.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-money.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-organization.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-organization.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-percentage.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-percentage.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-person.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-person.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-ner-time.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-ner-time.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-pos-maxent.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-pos-maxent.bin
+ [get] Getting: http://opennlp.sourceforge.net/models-1.5/en-chunker.bin
+ [get] To: OpenNlpTextAnalyzer/models/en-chunker.bin
+ [zip] Building zip: OpenNlpTextAnalyzer.pear
+
+BUILD SUCCESSFUL
+Total time: 3 minutes 20 seconds]]>
+ </screen>
+ </para>
+ <para>
+ After the pear is installed start the Cas Visual Debugger shipped with the UIMA framework.
+ And click on Tools -> Load AE. Then select the opennlp.uima.OpenNlpTextAnalyzer_pear.xml
+ file in the file dialog. Now enter some text and start the analysis engine with
+ "Run -> Run OpenNLPTextAnalyzer". Afterwards the results will be displayed.
+ You should see sentences, tokens, chunks, pos tags and maybe some names. Remember the input text
+ must be written in English.
+ </para>
+ </section>
+</chapter>
\ No newline at end of file
Propchange: incubator/opennlp/trunk/opennlp-docs/src/docbkx/uima-integration.xml
------------------------------------------------------------------------------
svn:mime-type = text/plain