Revision: 16750
          http://sourceforge.net/p/gate/code/16750
Author:   adamfunk
Date:     2013-07-24 14:13:37 +0000 (Wed, 24 Jul 2013)
Log Message:
-----------
Document the recent additions to the Score Copier PR.

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

Modified: userguide/trunk/misc-creole.tex
===================================================================
--- userguide/trunk/misc-creole.tex     2013-07-24 13:33:52 UTC (rev 16749)
+++ userguide/trunk/misc-creole.tex     2013-07-24 14:13:37 UTC (rev 16750)
@@ -3153,7 +3153,7 @@
   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.
+  output and the Termbank Score Copier PR.
 \item \textbf{debugMode} (\texttt{Boolean}): this sets the verbosity of the
   output while creating the termbank.
 \end{itemize}
@@ -3221,19 +3221,29 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \subsect{Termbank Score Copier}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-This processing resource copies the scores from a termbank into features of the
-term annotations.  It has no init parameters and two runtime parameters.
+This processing resource copies the scores and optionally frequencies from a
+termbank into features of the term annotations.  It has no init parameters and
+two runtime parameters.
 %%
 \begin{itemize}
 \item \textbf{annotationSetName}
+\item \textbf{frequencyFeature} default value \emph{frequency}
+\item \textbf{docFrequencyFeature} default value \emph{docFrequency}
 \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.
+type and matching string and language feature (where a missing feature matches
+the triple-underscore ``not found'' code) as a match, and copies the score to a
+feature on the annotation specified by the termbank's \emph{scoreProperty}
+parameter.  
+
+It also copies the term frequency to the annotation's \emph{frequencyFeature}
+unless that parameter is blank; and copies the document frequency to the
+\emph{docFrequencyFeature} unless that is blank.  Note that the default values
+are not blank---you need to clear either or both parameters to prevent these
+annotation features from being filled in.
 %
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % 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.


------------------------------------------------------------------------------
See everything from the browser to the database with AppDynamics
Get end-to-end visibility with application monitoring from AppDynamics
Isolate bottlenecks and diagnose root cause in seconds.
Start your free trial of AppDynamics Pro today!
http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs

Reply via email to