blob: 3baf5c10002cb12954a1c603deb8813dbef906e1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Record Class opennlp.tools.util.TrainingConfiguration (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="use: package: opennlp.tools.util, record: TrainingConfiguration">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">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><a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Record Class opennlp.tools.util.TrainingConfiguration" class="title">Uses of Record Class<br>opennlp.tools.util.TrainingConfiguration</h1>
</div>
<div class="caption"><span>Packages that use <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#opennlp.tools.commons">opennlp.tools.commons</a></div>
<div class="col-last even-row-color">
<div class="block">Package related to common interfaces used in different contexts.</div>
</div>
<div class="col-first odd-row-color"><a href="#opennlp.tools.ml">opennlp.tools.ml</a></div>
<div class="col-last odd-row-color">
<div class="block">Package related to Machine Learning (ML) features of OpenNLP, the related ML models, and trainers.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="opennlp.tools.commons">
<h2>Uses of <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a> in <a href="../../commons/package-summary.html">opennlp.tools.commons</a></h2>
<div class="caption"><span>Methods in <a href="../../commons/package-summary.html">opennlp.tools.commons</a> with parameters of type <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Trainer.</span><code><a href="../../commons/Trainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map,opennlp.tools.util.TrainingConfiguration)" class="member-name-link">init</a><wbr>(<a href="../TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;trainParams,
<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,
<a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a>&nbsp;config)</code></div>
<div class="col-last even-row-color">
<div class="block">Conducts the initialization of a <a href="../../commons/Trainer.html" title="interface in opennlp.tools.commons"><code>Trainer</code></a> via
<a href="../TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></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> and <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util"><code>TrainingConfiguration</code></a></div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="opennlp.tools.ml">
<h2>Uses of <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a> in <a href="../../ml/package-summary.html">opennlp.tools.ml</a></h2>
<div class="caption"><span>Fields in <a href="../../ml/package-summary.html">opennlp.tools.ml</a> declared as <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></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>protected <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractTrainer.</span><code><a href="../../ml/AbstractTrainer.html#trainingConfiguration" class="member-name-link">trainingConfiguration</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../../ml/package-summary.html">opennlp.tools.ml</a> that return <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AbstractTrainer.</span><code><a href="../../ml/AbstractTrainer.html#getTrainingConfiguration()" class="member-name-link">getTrainingConfiguration</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Retrieves the <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util"><code>TrainingConfiguration</code></a> associated with an <a href="../../ml/AbstractTrainer.html" title="class in opennlp.tools.ml"><code>AbstractTrainer</code></a>.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../../ml/package-summary.html">opennlp.tools.ml</a> with parameters of type <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="../../ml/EventTrainer.html" title="interface in opennlp.tools.ml">EventTrainer</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">TrainerFactory.</span><code><a href="../../ml/TrainerFactory.html#getEventTrainer(opennlp.tools.util.TrainingParameters,java.util.Map,opennlp.tools.util.TrainingConfiguration)" class="member-name-link">getEventTrainer</a><wbr>(<a href="../TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;trainParams,
<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,
<a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a>&nbsp;config)</code></div>
<div class="col-last even-row-color">
<div class="block">Retrieves an <a href="../../ml/EventTrainer.html" title="interface in opennlp.tools.ml"><code>EventTrainer</code></a> that fits the given parameters.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">AbstractTrainer.</span><code><a href="../../ml/AbstractTrainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map,opennlp.tools.util.TrainingConfiguration)" class="member-name-link">init</a><wbr>(<a href="../TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a>&nbsp;trainParams,
<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,
<a href="../TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color">
<div class="block">Conducts the initialization of a <a href="../../commons/Trainer.html" title="interface in opennlp.tools.commons"><code>Trainer</code></a> via
<a href="../TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></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> and <a href="../TrainingConfiguration.html" title="class in opennlp.tools.util"><code>TrainingConfiguration</code></a></div>
</div>
</div>
</section>
</li>
</ul>
</section>
</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>