http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DomainToModelMap.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DomainToModelMap.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DomainToModelMap.html new file mode 100644 index 0000000..1514670 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DomainToModelMap.html @@ -0,0 +1,325 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:58 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +DomainToModelMap (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.maxent.DomainToModelMap class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DomainToModelMap (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DataStream.html" title="interface in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/DomainToModelMap.html" target="_top"><B>FRAMES</B></A> + <A HREF="DomainToModelMap.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.maxent</FONT> +<BR> +Class DomainToModelMap</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.maxent.DomainToModelMap</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>DomainToModelMap</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></DL> +</PRE> + +<P> +A class which stores a mapping from ModelDomain objects to MaxentModels. + This permits an application to replace an old model for a domain with a + newly trained one in a thread-safe manner. By calling the getModel() + method, the application can create new instances of classes which use the + relevant models. +<P> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/maxent/DomainToModelMap.html#DomainToModelMap()">DomainToModelMap</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DomainToModelMap.html#getModel(opennlp.maxent.ModelDomain)">getModel</A></B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain)</CODE> + +<BR> + Get the model mapped to by the given ModelDomain key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html"; title="class or interface in java.util">Set</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DomainToModelMap.html#keySet()">keySet</A></B>()</CODE> + +<BR> + A set view of the ModelDomain keys contained in this map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DomainToModelMap.html#removeDomain(opennlp.maxent.ModelDomain)">removeDomain</A></B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain)</CODE> + +<BR> + Removes the mapping for this ModelDomain key from this map if present.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DomainToModelMap.html#setModelForDomain(opennlp.maxent.ModelDomain, opennlp.model.MaxentModel)">setModelForDomain</A></B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain, + <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A> model)</CODE> + +<BR> + Sets the model for the given domain.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="DomainToModelMap()"><!-- --></A><H3> +DomainToModelMap</H3> +<PRE> +public <B>DomainToModelMap</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="setModelForDomain(opennlp.maxent.ModelDomain, opennlp.model.MaxentModel)"><!-- --></A><H3> +setModelForDomain</H3> +<PRE> +public void <B>setModelForDomain</B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain, + <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A> model)</PRE> +<DL> +<DD>Sets the model for the given domain. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>domain</CODE> - The ModelDomain object which keys to the model.<DD><CODE>model</CODE> - The MaxentModel trained for the domain.</DL> +</DD> +</DL> +<HR> + +<A NAME="getModel(opennlp.maxent.ModelDomain)"><!-- --></A><H3> +getModel</H3> +<PRE> +public <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A> <B>getModel</B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain)</PRE> +<DL> +<DD>Get the model mapped to by the given ModelDomain key. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>domain</CODE> - The ModelDomain object which keys to the desired model. +<DT><B>Returns:</B><DD>The MaxentModel corresponding to the given domain.</DL> +</DD> +</DL> +<HR> + +<A NAME="removeDomain(opennlp.maxent.ModelDomain)"><!-- --></A><H3> +removeDomain</H3> +<PRE> +public void <B>removeDomain</B>(<A HREF="../../opennlp/maxent/ModelDomain.html" title="interface in opennlp.maxent">ModelDomain</A> domain)</PRE> +<DL> +<DD>Removes the mapping for this ModelDomain key from this map if present. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>domain</CODE> - The ModelDomain key whose mapping is to be removed from the map.</DL> +</DD> +</DL> +<HR> + +<A NAME="keySet()"><!-- --></A><H3> +keySet</H3> +<PRE> +public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html"; title="class or interface in java.util">Set</A> <B>keySet</B>()</PRE> +<DL> +<DD>A set view of the ModelDomain keys contained in this map. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>a set view of the ModelDomain keys contained in this map</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DataStream.html" title="interface in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/DomainToModelMap.html" target="_top"><B>FRAMES</B></A> + <A HREF="DomainToModelMap.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DoubleStringPair.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DoubleStringPair.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DoubleStringPair.html new file mode 100644 index 0000000..e53fa59 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/DoubleStringPair.html @@ -0,0 +1,310 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:58 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +DoubleStringPair (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.maxent.DoubleStringPair class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DoubleStringPair (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DomainToModelMap.html" title="class in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/DoubleStringPair.html" target="_top"><B>FRAMES</B></A> + <A HREF="DoubleStringPair.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.maxent</FONT> +<BR> +Class DoubleStringPair</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.maxent.DoubleStringPair</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html"; title="class or interface in java.lang">Comparable</A><<A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent">DoubleStringPair</A>></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>DoubleStringPair</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html"; title="class or interface in java.lang">Comparable</A><<A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent">DoubleStringPair</A>></DL> +</PRE> + +<P> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> double</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DoubleStringPair.html#doubleValue">doubleValue</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DoubleStringPair.html#stringValue">stringValue</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/maxent/DoubleStringPair.html#DoubleStringPair(double, java.lang.String)">DoubleStringPair</A></B>(double d, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> s)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/DoubleStringPair.html#compareTo(opennlp.maxent.DoubleStringPair)">compareTo</A></B>(<A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent">DoubleStringPair</A> p)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="stringValue"><!-- --></A><H3> +stringValue</H3> +<PRE> +public final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>stringValue</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="doubleValue"><!-- --></A><H3> +doubleValue</H3> +<PRE> +public final double <B>doubleValue</B></PRE> +<DL> +<DL> +</DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="DoubleStringPair(double, java.lang.String)"><!-- --></A><H3> +DoubleStringPair</H3> +<PRE> +public <B>DoubleStringPair</B>(double d, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> s)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="compareTo(opennlp.maxent.DoubleStringPair)"><!-- --></A><H3> +compareTo</H3> +<PRE> +public int <B>compareTo</B>(<A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent">DoubleStringPair</A> p)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html"; title="class or interface in java.lang">Comparable</A><<A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent">DoubleStringPair</A>></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DomainToModelMap.html" title="class in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/DoubleStringPair.html" target="_top"><B>FRAMES</B></A> + <A HREF="DoubleStringPair.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/Evalable.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/Evalable.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/Evalable.html new file mode 100644 index 0000000..e84aac3 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/Evalable.html @@ -0,0 +1,269 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:58 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +Evalable (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.maxent.Evalable interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="Evalable (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/GIS.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/Evalable.html" target="_top"><B>FRAMES</B></A> + <A HREF="Evalable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.maxent</FONT> +<BR> +Interface Evalable</H2> +<HR> +<DL> +<DT><PRE>public interface <B>Evalable</B></DL> +</PRE> + +<P> +Interface for components which use maximum entropy models and can evaluate + the performace of the models using the TrainEval class. +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/EventCollector.html" title="interface in opennlp.model">EventCollector</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/Evalable.html#getEventCollector(java.io.Reader)">getEventCollector</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html"; title="class or interface in java.io">Reader</A> r)</CODE> + +<BR> + Returns the EventCollector that is used to collect all relevant information + from the data file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/Evalable.html#getNegativeOutcome()">getNegativeOutcome</A></B>()</CODE> + +<BR> + The outcome that should be considered a negative result.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/Evalable.html#localEval(opennlp.model.MaxentModel, java.io.Reader, opennlp.maxent.Evalable, boolean)">localEval</A></B>(<A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html"; title="class or interface in java.io">Reader</A> r, + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent">Evalable</A> e, + boolean verbose)</CODE> + +<BR> + If the -l option is selected for evaluation, this method will be called + rather than TrainEval's evaluation method.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getNegativeOutcome()"><!-- --></A><H3> +getNegativeOutcome</H3> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>getNegativeOutcome</B>()</PRE> +<DL> +<DD>The outcome that should be considered a negative result. This is used for + computing recall. In the case of binary decisions, this would be the false + one. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the events that this EventCollector has gathered</DL> +</DD> +</DL> +<HR> + +<A NAME="getEventCollector(java.io.Reader)"><!-- --></A><H3> +getEventCollector</H3> +<PRE> +<A HREF="../../opennlp/model/EventCollector.html" title="interface in opennlp.model">EventCollector</A> <B>getEventCollector</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html"; title="class or interface in java.io">Reader</A> r)</PRE> +<DL> +<DD>Returns the EventCollector that is used to collect all relevant information + from the data file. This is used for to test the predictions of the model. + Note that if some of your features are the oucomes of previous events, this + method will give you results assuming 100% performance on the previous + events. If you don't like this, use the localEval method. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>r</CODE> - A reader containing the data for the event collector +<DT><B>Returns:</B><DD>an EventCollector</DL> +</DD> +</DL> +<HR> + +<A NAME="localEval(opennlp.model.MaxentModel, java.io.Reader, opennlp.maxent.Evalable, boolean)"><!-- --></A><H3> +localEval</H3> +<PRE> +void <B>localEval</B>(<A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html"; title="class or interface in java.io">Reader</A> r, + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent">Evalable</A> e, + boolean verbose)</PRE> +<DL> +<DD>If the -l option is selected for evaluation, this method will be called + rather than TrainEval's evaluation method. This is good if your features + includes the outcomes of previous events. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>model</CODE> - the maxent model to evaluate<DD><CODE>r</CODE> - Reader containing the data to process<DD><CODE>e</CODE> - The original Evalable. Probably not relevant.<DD><CODE>verbose</CODE> - a request to print more specific processing information</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/DoubleStringPair.html" title="class in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/GIS.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/Evalable.html" target="_top"><B>FRAMES</B></A> + <A HREF="Evalable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/GIS.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/GIS.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/GIS.html new file mode 100644 index 0000000..162ac26 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/maxent/GIS.html @@ -0,0 +1,616 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:58 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +GIS (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.maxent.GIS class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="GIS (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/GIS.html" target="_top"><B>FRAMES</B></A> + <A HREF="GIS.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.maxent</FONT> +<BR> +Class GIS</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.maxent.GIS</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>GIS</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></DL> +</PRE> + +<P> +A Factory class which uses instances of GISTrainer to create and train + GISModels. +<P> + +<P> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#PRINT_MESSAGES">PRINT_MESSAGES</A></B></CODE> + +<BR> + Set this to false if you don't want messages about the progress of model + training displayed.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static double</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#SMOOTHING_OBSERVATION">SMOOTHING_OBSERVATION</A></B></CODE> + +<BR> + If we are using smoothing, this is used as the "number" of times we want + the trainer to imagine that it saw a feature that it actually didn't see.</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#GIS()">GIS</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(opennlp.model.EventStream)">trainModel</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream)</CODE> + +<BR> + Train a model using the GIS algorithm, assuming 100 iterations and no + cutoff.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(opennlp.model.EventStream, boolean)">trainModel</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + boolean smoothing)</CODE> + +<BR> + Train a model using the GIS algorithm, assuming 100 iterations and no + cutoff.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(opennlp.model.EventStream, int, int)">trainModel</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(opennlp.model.EventStream, int, int, boolean, boolean)">trainModel</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff, + boolean smoothing, + boolean printMessagesWhileTraining)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(opennlp.model.EventStream, int, int, double)">trainModel</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff, + double sigma)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(int, opennlp.model.DataIndexer)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(int, opennlp.model.DataIndexer, boolean)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean smoothing)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(int, opennlp.model.DataIndexer, boolean, boolean, opennlp.model.Prior, int)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean printMessagesWhileTraining, + boolean smoothing, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(int, opennlp.model.DataIndexer, boolean, boolean, opennlp.model.Prior, int, int)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean printMessagesWhileTraining, + boolean smoothing, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff, + int threads)</CODE> + +<BR> + Train a model using the GIS algorithm.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/maxent/GIS.html#trainModel(int, opennlp.model.DataIndexer, opennlp.model.Prior, int)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff)</CODE> + +<BR> + Train a model using the GIS algorithm with the specified number of + iterations, data indexer, and prior.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="PRINT_MESSAGES"><!-- --></A><H3> +PRINT_MESSAGES</H3> +<PRE> +public static boolean <B>PRINT_MESSAGES</B></PRE> +<DL> +<DD>Set this to false if you don't want messages about the progress of model + training displayed. Alternately, you can use the overloaded version of + trainModel() to conditionally enable progress messages. +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="SMOOTHING_OBSERVATION"><!-- --></A><H3> +SMOOTHING_OBSERVATION</H3> +<PRE> +public static double <B>SMOOTHING_OBSERVATION</B></PRE> +<DL> +<DD>If we are using smoothing, this is used as the "number" of times we want + the trainer to imagine that it saw a feature that it actually didn't see. + Defaulted to 0.1. +<P> +<DL> +</DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="GIS()"><!-- --></A><H3> +GIS</H3> +<PRE> +public <B>GIS</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="trainModel(opennlp.model.EventStream)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD>Train a model using the GIS algorithm, assuming 100 iterations and no + cutoff. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>eventStream</CODE> - The EventStream holding the data on which this model will be + trained. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object. +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(opennlp.model.EventStream, boolean)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + boolean smoothing) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD>Train a model using the GIS algorithm, assuming 100 iterations and no + cutoff. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>eventStream</CODE> - The EventStream holding the data on which this model will be + trained.<DD><CODE>smoothing</CODE> - Defines whether the created trainer will use smoothing while + training the model. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object. +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(opennlp.model.EventStream, int, int)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>eventStream</CODE> - The EventStream holding the data on which this model will be + trained.<DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>cutoff</CODE> - The number of times a feature must be seen in order to be relevant + for training. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object. +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(opennlp.model.EventStream, int, int, boolean, boolean)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff, + boolean smoothing, + boolean printMessagesWhileTraining) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>eventStream</CODE> - The EventStream holding the data on which this model will be + trained.<DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>cutoff</CODE> - The number of times a feature must be seen in order to be relevant + for training.<DD><CODE>smoothing</CODE> - Defines whether the created trainer will use smoothing while + training the model.<DD><CODE>printMessagesWhileTraining</CODE> - Determines whether training status messages are written to STDOUT. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object. +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(opennlp.model.EventStream, int, int, double)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream, + int iterations, + int cutoff, + double sigma) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>eventStream</CODE> - The EventStream holding the data on which this model will be + trained.<DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>cutoff</CODE> - The number of times a feature must be seen in order to be relevant + for training.<DD><CODE>sigma</CODE> - The standard deviation for the gaussian smoother. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object. +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, boolean)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean smoothing)</PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>indexer</CODE> - The object which will be used for event compilation.<DD><CODE>smoothing</CODE> - Defines whether the created trainer will use smoothing while + training the model. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object.</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer)</PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>indexer</CODE> - The object which will be used for event compilation. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object.</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, opennlp.model.Prior, int)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff)</PRE> +<DL> +<DD>Train a model using the GIS algorithm with the specified number of + iterations, data indexer, and prior. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>indexer</CODE> - The object which will be used for event compilation.<DD><CODE>modelPrior</CODE> - The prior distribution for the model. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object.</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, boolean, boolean, opennlp.model.Prior, int)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean printMessagesWhileTraining, + boolean smoothing, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff)</PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>indexer</CODE> - The object which will be used for event compilation.<DD><CODE>printMessagesWhileTraining</CODE> - Determines whether training status messages are written to STDOUT.<DD><CODE>smoothing</CODE> - Defines whether the created trainer will use smoothing while + training the model.<DD><CODE>modelPrior</CODE> - The prior distribution for the model.<DD><CODE>cutoff</CODE> - The number of times a predicate must occur to be used in a model. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object.</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, boolean, boolean, opennlp.model.Prior, int, int)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public static <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> indexer, + boolean printMessagesWhileTraining, + boolean smoothing, + <A HREF="../../opennlp/model/Prior.html" title="interface in opennlp.model">Prior</A> modelPrior, + int cutoff, + int threads)</PRE> +<DL> +<DD>Train a model using the GIS algorithm. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>iterations</CODE> - The number of GIS iterations to perform.<DD><CODE>indexer</CODE> - The object which will be used for event compilation.<DD><CODE>printMessagesWhileTraining</CODE> - Determines whether training status messages are written to STDOUT.<DD><CODE>smoothing</CODE> - Defines whether the created trainer will use smoothing while + training the model.<DD><CODE>modelPrior</CODE> - The prior distribution for the model.<DD><CODE>cutoff</CODE> - The number of times a predicate must occur to be used in a model. +<DT><B>Returns:</B><DD>The newly trained model, which can be used immediately or saved to + disk using an opennlp.maxent.io.GISModelWriter object.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/maxent/Evalable.html" title="interface in opennlp.maxent"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/maxent/GIS.html" target="_top"><B>FRAMES</B></A> + <A HREF="GIS.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML>
