Google Git
Sign in
apache / opennlp-site / 176e3979407c843c86ef619262b2a3ac476de972 / . / docs / 2.3.3 / apidocs / opennlp-tools / opennlp / tools / ml / maxent / quasinewton / QNTrainer.html
blob: 83f8c00071fb70093adb4a8245414879d599fa5b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>QNTrainer (Apache OpenNLP Tools 2.3.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: opennlp.tools.ml.maxent.quasinewton, class: QNTrainer">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">opennlp.tools.ml.maxent.quasinewton</a></div>
<h1 title="Class QNTrainer" class="title">Class QNTrainer</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml">opennlp.tools.ml.AbstractTrainer</a>
<div class="inheritance"><a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">opennlp.tools.ml.AbstractEventTrainer</a>
<div class="inheritance">opennlp.tools.ml.maxent.quasinewton.QNTrainer</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../commons/Trainer.html" title="interface in opennlp.tools.commons">Trainer</a></code>, <code><a href="../../EventTrainer.html" title="interface in opennlp.tools.ml">EventTrainer</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QNTrainer</span>
<span class="extends-implements">extends <a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></span></div>
<div class="block">A Maxent model <a href="../../../commons/Trainer.html" title="interface in opennlp.tools.commons"><code>Trainer</code></a> using L-BFGS algorithm.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="QNModel.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNModel</code></a></li>
<li><a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml"><code>AbstractEventTrainer</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#L1COST_DEFAULT" class="member-name-link">L1COST_DEFAULT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#L1COST_PARAM" class="member-name-link">L1COST_PARAM</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#L2COST_DEFAULT" class="member-name-link">L2COST_DEFAULT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#L2COST_PARAM" class="member-name-link">L2COST_PARAM</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#M_DEFAULT" class="member-name-link">M_DEFAULT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#M_PARAM" class="member-name-link">M_PARAM</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#MAX_FCT_EVAL_DEFAULT" class="member-name-link">MAX_FCT_EVAL_DEFAULT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#MAX_FCT_EVAL_PARAM" class="member-name-link">MAX_FCT_EVAL_PARAM</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#MAXENT_QN_VALUE" class="member-name-link">MAXENT_QN_VALUE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#THREADS_DEFAULT" class="member-name-link">THREADS_DEFAULT</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#THREADS_PARAM" class="member-name-link">THREADS_PARAM</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-opennlp.tools.ml.AbstractEventTrainer">Fields inherited from class&nbsp;opennlp.tools.ml.<a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></h3>
<code><a href="../../AbstractEventTrainer.html#DATA_INDEXER_ONE_PASS_REAL_VALUE">DATA_INDEXER_ONE_PASS_REAL_VALUE</a>, <a href="../../AbstractEventTrainer.html#DATA_INDEXER_ONE_PASS_VALUE">DATA_INDEXER_ONE_PASS_VALUE</a>, <a href="../../AbstractEventTrainer.html#DATA_INDEXER_PARAM">DATA_INDEXER_PARAM</a>, <a href="../../AbstractEventTrainer.html#DATA_INDEXER_TWO_PASS_VALUE">DATA_INDEXER_TWO_PASS_VALUE</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-opennlp.tools.ml.AbstractTrainer">Fields inherited from class&nbsp;opennlp.tools.ml.<a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></h3>
<code><a href="../../AbstractTrainer.html#ALGORITHM_PARAM">ALGORITHM_PARAM</a>, <a href="../../AbstractTrainer.html#CUTOFF_DEFAULT">CUTOFF_DEFAULT</a>, <a href="../../AbstractTrainer.html#CUTOFF_PARAM">CUTOFF_PARAM</a>, <a href="../../AbstractTrainer.html#ITERATIONS_DEFAULT">ITERATIONS_DEFAULT</a>, <a href="../../AbstractTrainer.html#ITERATIONS_PARAM">ITERATIONS_PARAM</a>, <a href="../../AbstractTrainer.html#TRAINER_TYPE_PARAM">TRAINER_TYPE_PARAM</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-opennlp.tools.ml.EventTrainer">Fields inherited from interface&nbsp;opennlp.tools.ml.<a href="../../EventTrainer.html" title="interface in opennlp.tools.ml">EventTrainer</a></h3>
<code><a href="../../EventTrainer.html#EVENT_VALUE">EVENT_VALUE</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">QNTrainer</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">QNTrainer</a><wbr>(int&nbsp;m)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int)" class="member-name-link">QNTrainer</a><wbr>(int&nbsp;m,
int&nbsp;maxFctEval)</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(opennlp.tools.util.TrainingParameters)" class="member-name-link">QNTrainer</a><wbr>(<a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;parameters)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doTrain(opennlp.tools.ml.model.DataIndexer)" class="member-name-link">doTrain</a><wbr>(<a href="../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model">DataIndexer</a>&nbsp;indexer)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init(opennlp.tools.util.TrainingParameters,java.util.Map)" class="member-name-link">init</a><wbr>(<a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;trainingParameters,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;reportMap)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initializes a <a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml"><code>AbstractTrainer</code></a> via <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> and
a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>report map</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSortAndMerge()" class="member-name-link">isSortAndMerge</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="QNModel.html" title="class in opennlp.tools.ml.maxent.quasinewton">QNModel</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trainModel(int,opennlp.tools.ml.model.DataIndexer)" class="member-name-link">trainModel</a><wbr>(int&nbsp;iterations,
<a href="../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model">DataIndexer</a>&nbsp;indexer)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Trains a model using the QN algorithm.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate()" class="member-name-link">validate</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks the configured <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>parameters</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.ml.AbstractEventTrainer">Methods inherited from class&nbsp;opennlp.tools.ml.<a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></h3>
<code><a href="../../AbstractEventTrainer.html#getDataIndexer(opennlp.tools.util.ObjectStream)">getDataIndexer</a>, <a href="../../AbstractEventTrainer.html#train(opennlp.tools.ml.model.DataIndexer)">train</a>, <a href="../../AbstractEventTrainer.html#train(opennlp.tools.util.ObjectStream)">train</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.ml.AbstractTrainer">Methods inherited from class&nbsp;opennlp.tools.ml.<a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></h3>
<code><a href="../../AbstractTrainer.html#getAlgorithm()">getAlgorithm</a>, <a href="../../AbstractTrainer.html#getCutoff()">getCutoff</a>, <a href="../../AbstractTrainer.html#getIterations()">getIterations</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="MAXENT_QN_VALUE">
<h3>MAXENT_QN_VALUE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">MAXENT_QN_VALUE</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.MAXENT_QN_VALUE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="THREADS_PARAM">
<h3>THREADS_PARAM</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">THREADS_PARAM</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.THREADS_PARAM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="THREADS_DEFAULT">
<h3>THREADS_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">THREADS_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.THREADS_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="L1COST_PARAM">
<h3>L1COST_PARAM</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">L1COST_PARAM</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.L1COST_PARAM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="L1COST_DEFAULT">
<h3>L1COST_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">L1COST_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.L1COST_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="L2COST_PARAM">
<h3>L2COST_PARAM</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">L2COST_PARAM</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.L2COST_PARAM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="L2COST_DEFAULT">
<h3>L2COST_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">L2COST_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.L2COST_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="M_PARAM">
<h3>M_PARAM</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">M_PARAM</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.M_PARAM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="M_DEFAULT">
<h3>M_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">M_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.M_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="MAX_FCT_EVAL_PARAM">
<h3>MAX_FCT_EVAL_PARAM</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">MAX_FCT_EVAL_PARAM</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.MAX_FCT_EVAL_PARAM">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="MAX_FCT_EVAL_DEFAULT">
<h3>MAX_FCT_EVAL_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">MAX_FCT_EVAL_DEFAULT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#opennlp.tools.ml.maxent.quasinewton.QNTrainer.MAX_FCT_EVAL_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>QNTrainer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QNTrainer</span>()</div>
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.
<p>
<b>Note:</b><br>
The resulting instance does not print progress messages about training to STDOUT.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(opennlp.tools.util.TrainingParameters)">
<h3>QNTrainer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QNTrainer</span><wbr><span class="parameters">(<a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;parameters)</span></div>
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>parameters</code> - The <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to use.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int)">
<h3>QNTrainer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QNTrainer</span><wbr><span class="parameters">(int&nbsp;m)</span></div>
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>m</code> - The number of hessian updates to store.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int,int)">
<h3>QNTrainer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QNTrainer</span><wbr><span class="parameters">(int&nbsp;m,
int&nbsp;maxFctEval)</span></div>
<div class="block">Initializes a <a href="QNTrainer.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNTrainer</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>m</code> - The number of hessian updates to store.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="init(opennlp.tools.util.TrainingParameters,java.util.Map)">
<h3>init</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">init</span><wbr><span class="parameters">(<a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;trainingParameters,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;reportMap)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../AbstractTrainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map)">AbstractTrainer</a></code></span></div>
<div class="block">Initializes a <a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml"><code>AbstractTrainer</code></a> via <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> and
a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>report map</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../commons/Trainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map)">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../commons/Trainer.html" title="interface in opennlp.tools.commons">Trainer</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../../AbstractTrainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map)">init</a></code>&nbsp;in class&nbsp;<code><a href="../../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>trainingParameters</code> - The <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to use.</dd>
<dd><code>reportMap</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> instance used as report map.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="validate()">
<h3>validate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">validate</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../AbstractTrainer.html#validate()">AbstractTrainer</a></code></span></div>
<div class="block">Checks the configured <a href="../../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>parameters</code></a>.
If a subclass overrides this, it should call <code>super.validate();</code>.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../AbstractEventTrainer.html#validate()">validate</a></code>&nbsp;in class&nbsp;<code><a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isSortAndMerge()">
<h3>isSortAndMerge</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSortAndMerge</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../AbstractEventTrainer.html#isSortAndMerge()">isSortAndMerge</a></code>&nbsp;in class&nbsp;<code><a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="doTrain(opennlp.tools.ml.model.DataIndexer)">
<h3>doTrain</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></span>&nbsp;<span class="element-name">doTrain</span><wbr><span class="parameters">(<a href="../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model">DataIndexer</a>&nbsp;indexer)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../AbstractEventTrainer.html#doTrain(opennlp.tools.ml.model.DataIndexer)">doTrain</a></code>&nbsp;in class&nbsp;<code><a href="../../AbstractEventTrainer.html" title="class in opennlp.tools.ml">AbstractEventTrainer</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="trainModel(int,opennlp.tools.ml.model.DataIndexer)">
<h3>trainModel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="QNModel.html" title="class in opennlp.tools.ml.maxent.quasinewton">QNModel</a></span>&nbsp;<span class="element-name">trainModel</span><wbr><span class="parameters">(int&nbsp;iterations,
<a href="../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model">DataIndexer</a>&nbsp;indexer)</span></div>
<div class="block">Trains a model using the QN algorithm.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>iterations</code> - The number of QN iterations to perform.</dd>
<dd><code>indexer</code> - The <a href="../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a> used to compress events in memory.</dd>
<dt>Returns:</dt>
<dd>A trained <a href="QNModel.html" title="class in opennlp.tools.ml.maxent.quasinewton"><code>QNModel</code></a> which can be used immediately or saved to
disk using an <a href="../io/QNModelWriter.html" title="class in opennlp.tools.ml.maxent.io"><code>QNModelWriter</code></a>.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if parameters were invalid.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>