http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModel.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModel.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModel.html new file mode 100644 index 0000000..f4192d1 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModel.html @@ -0,0 +1,481 @@ +<!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:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +PerceptronModel (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.PerceptronModel class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PerceptronModel (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/perceptron/BinaryPerceptronModelWriter.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModel.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModel.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: <A HREF="#nested_classes_inherited_from_class_opennlp.model.AbstractModel">NESTED</A> | 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.perceptron</FONT> +<BR> +Class PerceptronModel</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 "><A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">opennlp.model.AbstractModel</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.perceptron.PerceptronModel</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model">MaxentModel</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>PerceptronModel</B><DT>extends <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></DL> +</PRE> + +<P> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + +<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> +</TR> +</TABLE> + <A NAME="nested_classes_inherited_from_class_opennlp.model.AbstractModel"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Nested classes/interfaces inherited from class opennlp.model.<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/model/AbstractModel.ModelType.html" title="enum in opennlp.model">AbstractModel.ModelType</A></CODE></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/perceptron/PerceptronModel.html#PerceptronModel(opennlp.model.Context[], java.lang.String[], opennlp.model.IndexHashTable, java.lang.String[])">PerceptronModel</A></B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model">IndexHashTable</A><<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>> pmap, + <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>[] outcomeNames)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModel.html#PerceptronModel(opennlp.model.Context[], java.lang.String[], java.util.Map, java.lang.String[])">PerceptronModel</A></B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html"; title="class or interface in java.util">Map</A><<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>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html"; title="class or interface in java.lang">Integer</A>> pmap, + <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>[] outcomeNames)</CODE> + +<BR> + <B>Deprecated.</B> <I>use the constructor with the <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><CODE>IndexHashTable</CODE></A> instead!</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModel.html#PerceptronModel(opennlp.model.Context[], java.lang.String[], java.lang.String[])">PerceptronModel</A></B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <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>[] outcomeNames)</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 double[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModel.html#eval(int[], double[], opennlp.model.EvalParameters)">eval</A></B>(int[] context, + double[] prior, + <A HREF="../../opennlp/model/EvalParameters.html" title="class in opennlp.model">EvalParameters</A> model)</CODE> + +<BR> + </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/perceptron/PerceptronModel.html#eval(int[], float[], double[], opennlp.model.EvalParameters, boolean)">eval</A></B>(int[] context, + float[] values, + double[] prior, + <A HREF="../../opennlp/model/EvalParameters.html" title="class in opennlp.model">EvalParameters</A> model, + boolean normalize)</CODE> + +<BR> + </TD> +</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/perceptron/PerceptronModel.html#eval(java.lang.String[])">eval</A></B>(<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>[] context)</CODE> + +<BR> + Evaluates a context.</TD> +</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/perceptron/PerceptronModel.html#eval(java.lang.String[], double[])">eval</A></B>(<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>[] context, + double[] probs)</CODE> + +<BR> + Evaluates a context.</TD> +</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/perceptron/PerceptronModel.html#eval(java.lang.String[], float[])">eval</A></B>(<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>[] context, + float[] values)</CODE> + +<BR> + Evaluates a contexts with the specified context values.</TD> +</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/perceptron/PerceptronModel.html#eval(java.lang.String[], float[], double[])">eval</A></B>(<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>[] context, + float[] values, + double[] outsums)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModel.html#main(java.lang.String[])">main</A></B>(<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>[] args)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_opennlp.model.AbstractModel"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.model.<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/model/AbstractModel.html#getAllOutcomes(double[])">getAllOutcomes</A>, <A HREF="../../opennlp/model/AbstractModel.html#getBestOutcome(double[])">getBestOutcome</A>, <A HREF="../../opennlp/model/AbstractModel.html#getDataStructures()">getDataStructures</A>, <A HREF="../../opennlp/model/AbstractModel.html#getIndex(java.lang.String)">getIndex</A>, <A HREF="../../opennlp/model/AbstractModel.html#getModelType()">getModelType</A>, <A HREF="../../opennlp/model/AbstractModel.html#getNumOutcomes()">getNumOutcomes</A>, <A HREF="../../opennlp/model/AbstractModel.html#getOutcome(int)">getOutcome</A></CODE></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="PerceptronModel(opennlp.model.Context[], java.lang.String[], opennlp.model.IndexHashTable, java.lang.String[])"><!-- --></A><H3> +PerceptronModel</H3> +<PRE> +public <B>PerceptronModel</B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model">IndexHashTable</A><<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>> pmap, + <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>[] outcomeNames)</PRE> +<DL> +</DL> +<HR> + +<A NAME="PerceptronModel(opennlp.model.Context[], java.lang.String[], java.util.Map, java.lang.String[])"><!-- --></A><H3> +PerceptronModel</H3> +<PRE> +<FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html"; title="class or interface in java.lang">@Deprecated</A> +</FONT>public <B>PerceptronModel</B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html"; title="class or interface in java.util">Map</A><<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>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html"; title="class or interface in java.lang">Integer</A>> pmap, + <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>[] outcomeNames)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>use the constructor with the <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><CODE>IndexHashTable</CODE></A> instead!</I> +<P> +</DL> +<HR> + +<A NAME="PerceptronModel(opennlp.model.Context[], java.lang.String[], java.lang.String[])"><!-- --></A><H3> +PerceptronModel</H3> +<PRE> +public <B>PerceptronModel</B>(<A HREF="../../opennlp/model/Context.html" title="class in opennlp.model">Context</A>[] params, + <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>[] predLabels, + <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>[] outcomeNames)</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="eval(java.lang.String[])"><!-- --></A><H3> +eval</H3> +<PRE> +public double[] <B>eval</B>(<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>[] context)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[])">MaxentModel</A></CODE></B></DD> +<DD>Evaluates a context. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different + outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(java.lang.String[], float[])"><!-- --></A><H3> +eval</H3> +<PRE> +public double[] <B>eval</B>(<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>[] context, + float[] values)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[], float[])">MaxentModel</A></CODE></B></DD> +<DD>Evaluates a contexts with the specified context values. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together.<DD><CODE>values</CODE> - The values associated with each context. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(java.lang.String[], double[])"><!-- --></A><H3> +eval</H3> +<PRE> +public double[] <B>eval</B>(<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>[] context, + double[] probs)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[], double[])">MaxentModel</A></CODE></B></DD> +<DD>Evaluates a context. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together.<DD><CODE>probs</CODE> - An array which is populated with the probabilities for each of the different + outcomes, all of which sum to 1. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(java.lang.String[], float[], double[])"><!-- --></A><H3> +eval</H3> +<PRE> +public double[] <B>eval</B>(<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>[] context, + float[] values, + double[] outsums)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(int[], double[], opennlp.model.EvalParameters)"><!-- --></A><H3> +eval</H3> +<PRE> +public static double[] <B>eval</B>(int[] context, + double[] prior, + <A HREF="../../opennlp/model/EvalParameters.html" title="class in opennlp.model">EvalParameters</A> model)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(int[], float[], double[], opennlp.model.EvalParameters, boolean)"><!-- --></A><H3> +eval</H3> +<PRE> +public static double[] <B>eval</B>(int[] context, + float[] values, + double[] prior, + <A HREF="../../opennlp/model/EvalParameters.html" title="class in opennlp.model">EvalParameters</A> model, + boolean normalize)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="main(java.lang.String[])"><!-- --></A><H3> +main</H3> +<PRE> +public static void <B>main</B>(<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>[] args) + 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><DL> + +<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> +<!-- ========= 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/perceptron/BinaryPerceptronModelWriter.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModel.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModel.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: <A HREF="#nested_classes_inherited_from_class_opennlp.model.AbstractModel">NESTED</A> | 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/perceptron/PerceptronModelReader.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelReader.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelReader.html new file mode 100644 index 0000000..5cf3ca1 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelReader.html @@ -0,0 +1,334 @@ +<!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:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +PerceptronModelReader (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.PerceptronModelReader class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PerceptronModelReader (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/perceptron/PerceptronModel.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModelReader.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModelReader.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.perceptron</FONT> +<BR> +Class PerceptronModelReader</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 "><A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">opennlp.model.AbstractModelReader</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.perceptron.PerceptronModelReader</B> +</PRE> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../opennlp/perceptron/BinaryPerceptronModelReader.html" title="class in opennlp.perceptron">BinaryPerceptronModelReader</A>, <A HREF="../../opennlp/perceptron/PlainTextPerceptronModelReader.html" title="class in opennlp.perceptron">PlainTextPerceptronModelReader</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>PerceptronModelReader</B><DT>extends <A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">AbstractModelReader</A></DL> +</PRE> + +<P> +Abstract parent class for readers of Perceptron. +<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/perceptron/PerceptronModelReader.html#PerceptronModelReader(opennlp.model.DataReader)">PerceptronModelReader</A></B>(<A HREF="../../opennlp/model/DataReader.html" title="interface in opennlp.model">DataReader</A> dataReader)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModelReader.html#PerceptronModelReader(java.io.File)">PerceptronModelReader</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file)</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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModelReader.html#checkModelType()">checkModelType</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModelReader.html#constructModel()">constructModel</A></B>()</CODE> + +<BR> + Retrieve a model from disk.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_opennlp.model.AbstractModelReader"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.model.<A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">AbstractModelReader</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/model/AbstractModelReader.html#getModel()">getModel</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readDouble()">readDouble</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readInt()">readInt</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readUTF()">readUTF</A></CODE></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="PerceptronModelReader(java.io.File)"><!-- --></A><H3> +PerceptronModelReader</H3> +<PRE> +public <B>PerceptronModelReader</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file) + 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> +<DL> + +<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> +</DL> +<HR> + +<A NAME="PerceptronModelReader(opennlp.model.DataReader)"><!-- --></A><H3> +PerceptronModelReader</H3> +<PRE> +public <B>PerceptronModelReader</B>(<A HREF="../../opennlp/model/DataReader.html" title="interface in opennlp.model">DataReader</A> dataReader)</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="constructModel()"><!-- --></A><H3> +constructModel</H3> +<PRE> +public <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> <B>constructModel</B>() + 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>Retrieve a model from disk. It assumes that models are saved in the + following sequence: + + <br>Perceptron (model type identifier) + <br>1. # of parameters (int) + <br>2. # of outcomes (int) + <br> * list of outcome names (String) + <br>3. # of different types of outcome patterns (int) + <br> * list of (int int[]) + <br> [# of predicates for which outcome pattern is true] [outcome pattern] + <br>4. # of predicates (int) + <br> * list of predicate names (String) + + <p>If you are creating a reader for a format which won't work with this + (perhaps a database or xml file), override this method and ignore the + other methods provided in this abstract class. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelReader.html#constructModel()">constructModel</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">AbstractModelReader</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>The PerceptronModel stored in the format and location specified to + this PerceptronModelReader (usually via its the constructor). +<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="checkModelType()"><!-- --></A><H3> +checkModelType</H3> +<PRE> +public void <B>checkModelType</B>() + 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><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelReader.html#checkModelType()">checkModelType</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">AbstractModelReader</A></CODE></DL> +</DD> +<DD><DL> + +<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> +<!-- ========= 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/perceptron/PerceptronModel.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModelReader.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModelReader.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/perceptron/PerceptronModelWriter.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelWriter.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelWriter.html new file mode 100644 index 0000000..114e521 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronModelWriter.html @@ -0,0 +1,281 @@ +<!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:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +PerceptronModelWriter (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.PerceptronModelWriter class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PerceptronModelWriter (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/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronTrainer.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModelWriter.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.perceptron</FONT> +<BR> +Class PerceptronModelWriter</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 "><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">opennlp.model.AbstractModelWriter</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.perceptron.PerceptronModelWriter</B> +</PRE> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../opennlp/perceptron/BinaryPerceptronModelWriter.html" title="class in opennlp.perceptron">BinaryPerceptronModelWriter</A>, <A HREF="../../opennlp/perceptron/PlainTextPerceptronModelWriter.html" title="class in opennlp.perceptron">PlainTextPerceptronModelWriter</A>, <A HREF="../../opennlp/perceptron/SuffixSensitivePerceptronModelWriter.html" title="class in opennlp.perceptron">SuffixSensitivePerceptronModelWriter</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public abstract class <B>PerceptronModelWriter</B><DT>extends <A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></DL> +</PRE> + +<P> +Abstract parent class for Perceptron writers. It provides the persist method + which takes care of the structure of a stored document, and requires an + extending class to define precisely how the data should be stored. +<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/perceptron/PerceptronModelWriter.html#PerceptronModelWriter(opennlp.model.AbstractModel)">PerceptronModelWriter</A></B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model)</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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronModelWriter.html#persist()">persist</A></B>()</CODE> + +<BR> + Writes the model to disk, using the <code>writeX()</code> methods + provided by extending classes.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_opennlp.model.AbstractModelWriter"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.model.<A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#close()">close</A>, <A HREF="../../opennlp/model/AbstractModelWriter.html#writeDouble(double)">writeDouble</A>, <A HREF="../../opennlp/model/AbstractModelWriter.html#writeInt(int)">writeInt</A>, <A HREF="../../opennlp/model/AbstractModelWriter.html#writeUTF(java.lang.String)">writeUTF</A></CODE></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="PerceptronModelWriter(opennlp.model.AbstractModel)"><!-- --></A><H3> +PerceptronModelWriter</H3> +<PRE> +public <B>PerceptronModelWriter</B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model)</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="persist()"><!-- --></A><H3> +persist</H3> +<PRE> +public void <B>persist</B>() + 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>Writes the model to disk, using the <code>writeX()</code> methods + provided by extending classes. + + <p>If you wish to create a PerceptronModelWriter which uses a different + structure, it will be necessary to override the persist method in + addition to implementing the <code>writeX()</code> methods. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#persist()">persist</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<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> +<!-- ========= 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/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronTrainer.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronModelWriter.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/perceptron/PerceptronTrainer.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronTrainer.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronTrainer.html new file mode 100644 index 0000000..eeb7aca --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/PerceptronTrainer.html @@ -0,0 +1,397 @@ +<!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:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +PerceptronTrainer (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.PerceptronTrainer class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="PerceptronTrainer (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/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PlainTextPerceptronModelReader.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronTrainer.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronTrainer.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.perceptron</FONT> +<BR> +Class PerceptronTrainer</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.perceptron.PerceptronTrainer</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>PerceptronTrainer</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> +Trains models using the perceptron algorithm. Each outcome is represented as + a binary perceptron classifier. This supports standard (integer) weighting as well + average weighting as described in: + Discriminative Training Methods for Hidden Markov Models: Theory and Experiments + with the Perceptron Algorithm. Michael Collins, EMNLP 2002. +<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 double</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronTrainer.html#TOLERANCE_DEFAULT">TOLERANCE_DEFAULT</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/perceptron/PerceptronTrainer.html#PerceptronTrainer()">PerceptronTrainer</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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronTrainer.html#setSkippedAveraging(boolean)">setSkippedAveraging</A></B>(boolean averaging)</CODE> + +<BR> + Enables skipped averaging, this flag changes the standard + averaging to special averaging instead.</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/perceptron/PerceptronTrainer.html#setStepSizeDecrease(double)">setStepSizeDecrease</A></B>(double decrease)</CODE> + +<BR> + Enables and sets step size decrease.</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/perceptron/PerceptronTrainer.html#setTolerance(double)">setTolerance</A></B>(double tolerance)</CODE> + +<BR> + Specifies the tolerance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronTrainer.html#trainModel(int, opennlp.model.DataIndexer, int)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> di, + int cutoff)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/perceptron/PerceptronTrainer.html#trainModel(int, opennlp.model.DataIndexer, int, boolean)">trainModel</A></B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> di, + int cutoff, + boolean useAverage)</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="TOLERANCE_DEFAULT"><!-- --></A><H3> +TOLERANCE_DEFAULT</H3> +<PRE> +public static final double <B>TOLERANCE_DEFAULT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#opennlp.perceptron.PerceptronTrainer.TOLERANCE_DEFAULT">Constant Field Values</A></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="PerceptronTrainer()"><!-- --></A><H3> +PerceptronTrainer</H3> +<PRE> +public <B>PerceptronTrainer</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="setTolerance(double)"><!-- --></A><H3> +setTolerance</H3> +<PRE> +public void <B>setTolerance</B>(double tolerance)</PRE> +<DL> +<DD>Specifies the tolerance. If the change in training set accuracy + is less than this, stop iterating. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>tolerance</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="setStepSizeDecrease(double)"><!-- --></A><H3> +setStepSizeDecrease</H3> +<PRE> +public void <B>setStepSizeDecrease</B>(double decrease)</PRE> +<DL> +<DD>Enables and sets step size decrease. The step size is + decreased every iteration by the specified value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>decrease</CODE> - - step size decrease in percent</DL> +</DD> +</DL> +<HR> + +<A NAME="setSkippedAveraging(boolean)"><!-- --></A><H3> +setSkippedAveraging</H3> +<PRE> +public void <B>setSkippedAveraging</B>(boolean averaging)</PRE> +<DL> +<DD>Enables skipped averaging, this flag changes the standard + averaging to special averaging instead. + <p> + If we are doing averaging, and the current iteration is one + of the first 20 or it is a perfect square, then updated the + summed parameters. + <p> + The reason we don't take all of them is that the parameters change + less toward the end of training, so they drown out the contributions + of the more volatile early iterations. The use of perfect + squares allows us to sample from successively farther apart iterations. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>averaging</CODE> - averaging flag</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, int)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> di, + int cutoff)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="trainModel(int, opennlp.model.DataIndexer, int, boolean)"><!-- --></A><H3> +trainModel</H3> +<PRE> +public <A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> <B>trainModel</B>(int iterations, + <A HREF="../../opennlp/model/DataIndexer.html" title="interface in opennlp.model">DataIndexer</A> di, + int cutoff, + boolean useAverage)</PRE> +<DL> +<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/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PlainTextPerceptronModelReader.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/PerceptronTrainer.html" target="_top"><B>FRAMES</B></A> + <A HREF="PerceptronTrainer.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>
