Revision: 16339
http://gate.svn.sourceforge.net/gate/?rev=16339&view=rev
Author: adamfunk
Date: 2012-11-27 15:39:31 +0000 (Tue, 27 Nov 2012)
Log Message:
-----------
Updating TermRaider section
Modified Paths:
--------------
userguide/trunk/misc-creole.tex
Modified: userguide/trunk/misc-creole.tex
===================================================================
--- userguide/trunk/misc-creole.tex 2012-11-27 15:38:07 UTC (rev 16338)
+++ userguide/trunk/misc-creole.tex 2012-11-27 15:39:31 UTC (rev 16339)
@@ -3002,26 +3002,27 @@
candidates.
\item \textbf{inputAnnotationTypes} (\texttt{Set<String>}): annotation types
which are treated as term candidates.
-\item \textbf{inputAnnotationFeature}: the feature of each
- annotation used as the term string (if it is missing, the string underlying
- the annotation in the document will be whitespace-trimmed and used). Note
- that these values are case-sensitive; normally the lemma (\emph{root} feature
- from the GATE Morphological Analyser) is used for consistency.
-\item \textbf{languageFeature}: (\texttt{String}) the feature of each
annotation
- identifying the language of the term. If this is missing, the missing code
- ``\verb!___!'' (three underscores) will be used.
-\item \textbf{docFreqProperty}
-\item \textbf{scoreProperty}
-\item \textbf{namespaceBase}
-\item \textbf{debugMode}
+\item \textbf{inputAnnotationFeature}: the feature of each annotation used as
+ the term string (if the feature is missing from the annotation, the
underlying
+ document content will be whitespace-trimmed and used). Note that these
values
+ are case-sensitive; normally the lemma (\emph{root} feature from the GATE
+ Morphological Analyser) is used for consistency.
+\item \textbf{languageFeature} (\texttt{String}): the feature of each
annotation
+ identifying the language of the term. (Annotations without the feature will
+ get a blank language code.)
+\item \textbf{scoreProperty}: a description of the score, used in the CSV
+ output.
+\item \textbf{debugMode} (\texttt{Boolean}): this sets the verbosity of the
+ output while creating the termbank.
\end{itemize}
The \texttt{Term} class is defined in terms of the term string itself, the
language code, and the annotation type, so
-(\emph{affect},\emph{eng},\emph{Noun}) is distinct from
-(\emph{affect},\emph{eng},\emph{Verb}), and
(\emph{gift},\emph{eng},\emph{Noun})
-is distinct from (\emph{gift},\emph{ger},\emph{Noun}).
+\emph{affect}(\emph{english},\emph{Noun}) is distinct from
+\emph{affect}(\emph{english},\emph{Verb}), and
+\emph{gift}(\emph{english},\emph{Noun}) is distinct from
+\emph{gift}(\emph{german},\emph{Noun}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsect{TfIdf Termbank}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -3029,30 +3030,38 @@
of corpora. It has the following additional init parameters.
%%
\begin{itemize}
-\item \textbf{idfCalculation}: an enum with the options \emph{Natural},
- \emph{Logarithmic}, or \emph{LogarithmicPlus1}...
-\item \textbf{tfCalculation}: an enum with the options \emph{Natural} or
- \emph{Logarithmic}.
+\item \textbf{idfCalculation}: an enum (pull-down menu in the GUI) with the
following
+ options for inverted document frequency:
+ \begin{itemize}
+ \item \emph{Natural} $= 1/df$;
+ \item \emph{Logarithmic} $=\log_{2}(n/df)$;
+ \item \emph{LogarithmicPlus1} $=1+\log_{2} (n/df)$.
+ \end{itemize}
+\item \textbf{tfCalculation}: an enum (pull-down) with the following options
for
+ term frequency:
+ \begin{itemize}
+ \item \emph{Natural} $=tf$;
+ \item \emph{Logarithmic} $=1+\log_{2} tf$.
+ \end{itemize}
\end{itemize}
-
-
-
-
+%%
+For these calcutations, $tf$ is the term frequency (number of occurrences of
the
+term in the corpora), $df$ is the document frequency (number of documents
+containing the term), and $n$ is the total number of documents.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsect{Annotation Termbank}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
This termbank collects the values of scoring features on all the term
candidates
-and aggregates them according to the \textbf{mergingMode} parameter. It has
the
-following additional init parameters.
+and selects the minimum or maximum score or averages them, according to the
+\textbf{mergingMode} parameter. It has the following additional init
+parameters.
%%
\begin{itemize}
\item \textbf{inputScoreFeature}: an annotation feature whose value should be a
\texttt{Number} or interpretable as a number.
-\item \textbf{nergingMode}: an enum with the options \emph{MINIMUM},
\emph{MEAN}, or
- \emph{MAXIMUM}.
+\item \textbf{mergingMode}: an enum (pull-down menu in the GUI) with the
options
+ \emph{MINIMUM}, \emph{MEAN}, or \emph{MAXIMUM}.
\end{itemize}
-
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsect{Hyponymy Termbank}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -3060,13 +3069,13 @@
term candidates. It has the following additional init parameter.
%%
\begin{itemize}
-\item \textbf{inputHeadFeatures}: (\texttt{List<String>})
+\item \textbf{inputHeadFeatures} (\texttt{List<String>}): annotation features
on
+ term candidates containing the head of the expression.
\end{itemize}
-%% explain how head is determined
-
-
-
-
+%%
+Head information is generated by the multiword JAPE grammar included in the
+application. We consider $T_1$ a hyponym of $T_2$ if and only if $T_2$ head
+feature value ends with $T_1$'s head or string feature value.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsect{Termbank Score Copier}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -3077,14 +3086,12 @@
\item \textbf{annotationSetName}
\item \textbf{termbank}
\end{itemize}
-
+%%
This PR uses the annotation types, string and language code features, and score
features from the selected termbank. It treats any annotation with a matching
type and matching string feature and language feature (where a missing feature
matches the triple-underscore ``not found'' code) as a match, and copies the
score from the termbank to the annotation's score feature.
-
-
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% OBVIOUSLY I'm not finished documenting this.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Monitor your physical, virtual and cloud infrastructure from a single
web console. Get in-depth insight into apps, servers, databases, vmware,
SAP, cloud infrastructure, etc. Download 30-day Free Trial.
Pricing starts from $795 for 25 servers or applications!
http://p.sf.net/sfu/zoho_dev2dev_nov
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
