blob: 4f486abd82975b3c4ae208ab807704ecd2f0e95a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>TrainingProgressMonitor (Apache OpenNLP Tools 2.5.6 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.monitoring, interface: TrainingProgressMonitor">
<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.7.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.monitoring</a></div>
<h1 title="Interface TrainingProgressMonitor" class="title">Interface TrainingProgressMonitor</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DefaultTrainingProgressMonitor.html" title="class in opennlp.tools.monitoring">DefaultTrainingProgressMonitor</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TrainingProgressMonitor</span></div>
<div class="block">An interface to capture training progress of an <a href="../ml/model/AbstractModel.html" title="class in opennlp.tools.ml.model"><code>AbstractModel</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<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-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#display(boolean)" class="member-name-link">display</a><wbr>(boolean&nbsp;clear)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Displays the training progress and optionally clears the recorded progress (to save memory).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#finishedIteration(int,int,int,opennlp.tools.monitoring.TrainingMeasure,double)" class="member-name-link">finishedIteration</a><wbr>(int&nbsp;iteration,
int&nbsp;numberCorrectEvents,
int&nbsp;totalEvents,
<a href="TrainingMeasure.html" title="enum class in opennlp.tools.monitoring">TrainingMeasure</a>&nbsp;measure,
double&nbsp;measureValue)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Captures the Iteration progress.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#finishedTraining(int,opennlp.tools.monitoring.StopCriteria)" class="member-name-link">finishedTraining</a><wbr>(int&nbsp;iterations,
<a href="StopCriteria.html" title="interface in opennlp.tools.monitoring">StopCriteria</a>&lt;?&gt;&nbsp;stopCriteria)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Captures the training completion progress.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isTrainingFinished()" class="member-name-link">isTrainingFinished</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks whether the training has finished.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="finishedIteration(int,int,int,opennlp.tools.monitoring.TrainingMeasure,double)">
<h3>finishedIteration</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">finishedIteration</span><wbr><span class="parameters">(int&nbsp;iteration,
int&nbsp;numberCorrectEvents,
int&nbsp;totalEvents,
<a href="TrainingMeasure.html" title="enum class in opennlp.tools.monitoring">TrainingMeasure</a>&nbsp;measure,
double&nbsp;measureValue)</span></div>
<div class="block">Captures the Iteration progress.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>iteration</code> - The completed iteration number.</dd>
<dd><code>numberCorrectEvents</code> - Number of correctly predicted events in this iteration.</dd>
<dd><code>totalEvents</code> - Total count of events processed in this iteration.</dd>
<dd><code>measure</code> - <a href="TrainingMeasure.html" title="enum class in opennlp.tools.monitoring"><code>TrainingMeasure</code></a>.</dd>
<dd><code>measureValue</code> - measure value corresponding to the applicable <a href="TrainingMeasure.html" title="enum class in opennlp.tools.monitoring"><code>TrainingMeasure</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="finishedTraining(int,opennlp.tools.monitoring.StopCriteria)">
<h3>finishedTraining</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">finishedTraining</span><wbr><span class="parameters">(int&nbsp;iterations,
<a href="StopCriteria.html" title="interface in opennlp.tools.monitoring">StopCriteria</a>&lt;?&gt;&nbsp;stopCriteria)</span></div>
<div class="block">Captures the training completion progress.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>iterations</code> - Total number of iterations configured for the training.</dd>
<dd><code>stopCriteria</code> - <a href="StopCriteria.html" title="interface in opennlp.tools.monitoring"><code>StopCriteria</code></a> for the training.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isTrainingFinished()">
<h3>isTrainingFinished</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isTrainingFinished</span>()</div>
<div class="block">Checks whether the training has finished.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the training has finished, <code>false</code> if the training is not yet completed.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="display(boolean)">
<h3>display</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">display</span><wbr><span class="parameters">(boolean&nbsp;clear)</span></div>
<div class="block">Displays the training progress and optionally clears the recorded progress (to save memory).
Callers of this method can invoke it periodically
during training, to avoid holding too much progress related data in memory.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clear</code> - Set to true to clear the recorded progress.</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; 2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>