[gate-cvs] SF.net SVN: gate:[16945] userguide/trunk

[<mar...@us...>]

Revision: 16945
          http://sourceforge.net/p/gate/code/16945
Author:   markagreenwood
Date:     2013-09-27 09:00:26 +0000 (Fri, 27 Sep 2013)
Log Message:
-----------
added documentation for the Tagger_Stanford plugin

Modified Paths:
--------------
    userguide/trunk/misc-creole.tex
    userguide/trunk/recent-changes.tex

Modified: userguide/trunk/misc-creole.tex
===================================================================
--- userguide/trunk/misc-creole.tex	2013-09-27 01:21:05 UTC (rev 16944)
+++ userguide/trunk/misc-creole.tex	2013-09-27 09:00:26 UTC (rev 16945)
@@ -2792,7 +2792,47 @@
 \htlink{https://opennlp.apache.org/documentation.html}{the OpenNLP document} for
 details.
 %%
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\sect[sec:misc:creole:stanford]{Stanford Part-of-Speech Tagger}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+To use the Stanford Part-of-Speech tagger\footnote{\url{http://www-nlp.stanford.edu/software/tagger.shtml}}
+within GATE you need first to load the \verb|Tagger_Stanford| plugin.
+
+The PR is configured using the following initialization time parameters:
+
+\begin{itemize}
+\item \textbf{modelFile:} the URL to the POS tagger model. This defaults to a
+  fast English model but further models for other languages are available from the
+  \htlink{http://www-nlp.stanford.edu/software/tagger.shtml}{tagger's homepage}.
+\end{itemize}
+
+Further configuration of the tagger is via the following runtime parameters:
+
+\begin{itemize}
+\item \textbf{baseSentenceAnnotationType:} the input annotation type which
+  represents sentences; defaults to Sentence.
+\item \textbf{baseTokenAnnotationType:} the input annotation type which
+  represents tokens; defaults to Token
+\item \textbf{failOnMissingInputAnnotations:} if true and no annotations of
+  the types specified in the previous two options are found then an an
+  exception will be thrown halting any further processing. If false, a warning
+  will be printed instead and processing will continue. Defaults to true to help
+  quickly catch misconfiguration during application development.
+\item \textbf{inputASName:} the name of the annotation set that serves as input
+  to the tagger (i.e. where the tagger will look for sentences and tokens to
+  process); defaults to the default unnamed annotation set.
+\item \textbf{outputASName:} the name of the annotation set into which the
+  results of running the tagger will be stored; defaults to the default unnamed
+  annotation set.
+\item \textbf{outputAnnotationType:} the annotation type which will be created,
+  or updated, with the results of running the tagger; defaults to Token.
+\item \textbf{posTagAllTokens:} if true all tokens will be processed, including
+  those that do not fall within a sentence; defaults to true.
+\end{itemize}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \sect[sec:misc-creole:boilerpipe]{Content Detection Using Boilerpipe}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 

Modified: userguide/trunk/recent-changes.tex
===================================================================
--- userguide/trunk/recent-changes.tex	2013-09-27 01:21:05 UTC (rev 16944)
+++ userguide/trunk/recent-changes.tex	2013-09-27 09:00:26 UTC (rev 16945)
@@ -36,6 +36,9 @@
   definately isn't).
 \end{itemize}
 
+A new plugin that wraps the Stanford Part-of-Speech tagger. See Section
+\ref{sec:misc:creole:stanford} for details.
+
 \rcSubsect{August 2013}
 
 Added support for Resource Helpers which can added new features to exisiting

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.