| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TrainerFactory (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, class: TrainerFactory"> |
| <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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">opennlp.tools.ml</a></div> |
| <h1 title="Class TrainerFactory" class="title">Class TrainerFactory</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">opennlp.tools.ml.TrainerFactory</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TrainerFactory</span> |
| <span class="extends-implements">extends <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></span></div> |
| <div class="block">A factory to initialize <a href="../commons/Trainer.html" title="interface in opennlp.tools.commons"><code>Trainer</code></a> instances depending on a trainer type |
| configured via <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="TrainerFactory.TrainerType.html" class="type-name-link" title="enum class in opennlp.tools.ml">TrainerFactory.TrainerType</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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">TrainerFactory</a>()</code></div> |
| <div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <T> <a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml">EventModelSequenceTrainer</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEventModelSequenceTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)" class="member-name-link">getEventModelSequenceTrainer</a><wbr>(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an <a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml"><code>EventModelSequenceTrainer</code></a> that fits the given parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="EventTrainer.html" title="interface in opennlp.tools.ml">EventTrainer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEventTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)" class="member-name-link">getEventTrainer</a><wbr>(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves an <a href="EventTrainer.html" title="interface in opennlp.tools.ml"><code>EventTrainer</code></a> that fits the given parameters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SequenceTrainer.html" title="interface in opennlp.tools.ml">SequenceTrainer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSequenceModelTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)" class="member-name-link">getSequenceModelTrainer</a><wbr>(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Retrieves a <a href="SequenceTrainer.html" title="interface in opennlp.tools.ml"><code>SequenceTrainer</code></a> that fits the given parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TrainerFactory.TrainerType.html" title="enum class in opennlp.tools.ml">TrainerFactory.TrainerType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTrainerType(opennlp.tools.util.TrainingParameters)" class="member-name-link">getTrainerType</a><wbr>(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Determines the <a href="TrainerFactory.TrainerType.html" title="enum class in opennlp.tools.ml"><code>TrainerFactory.TrainerType</code></a> based on the |
| <a href="AbstractTrainer.html#ALGORITHM_PARAM"><code>AbstractTrainer.ALGORITHM_PARAM</code></a> value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isValid(opennlp.tools.util.TrainingParameters)" class="member-name-link">isValid</a><wbr>(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>TrainerFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrainerFactory</span>()</div> |
| </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="getTrainerType(opennlp.tools.util.TrainingParameters)"> |
| <h3>getTrainerType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TrainerFactory.TrainerType.html" title="enum class in opennlp.tools.ml">TrainerFactory.TrainerType</a></span> <span class="element-name">getTrainerType</span><wbr><span class="parameters">(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams)</span></div> |
| <div class="block">Determines the <a href="TrainerFactory.TrainerType.html" title="enum class in opennlp.tools.ml"><code>TrainerFactory.TrainerType</code></a> based on the |
| <a href="AbstractTrainer.html#ALGORITHM_PARAM"><code>AbstractTrainer.ALGORITHM_PARAM</code></a> value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - - A mapping of <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>training parameters</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="TrainerFactory.TrainerType.html" title="enum class in opennlp.tools.ml"><code>TrainerFactory.TrainerType</code></a> or <code>null</code> if the type couldn't be determined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSequenceModelTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)"> |
| <h3>getSequenceModelTrainer</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SequenceTrainer.html" title="interface in opennlp.tools.ml">SequenceTrainer</a></span> <span class="element-name">getSequenceModelTrainer</span><wbr><span class="parameters">(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</span></div> |
| <div class="block">Retrieves a <a href="SequenceTrainer.html" title="interface in opennlp.tools.ml"><code>SequenceTrainer</code></a> that fits the given parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to check for the trainer type. |
| Note: The entry <a href="AbstractTrainer.html#ALGORITHM_PARAM"><code>AbstractTrainer.ALGORITHM_PARAM</code></a> is used |
| to determine the type.</dd> |
| <dd><code>reportMap</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>Map</code></a> that shall be used during initialization of |
| the <a href="SequenceTrainer.html" title="interface in opennlp.tools.ml"><code>SequenceTrainer</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid <a href="SequenceTrainer.html" title="interface in opennlp.tools.ml"><code>SequenceTrainer</code></a> for the configured <code>trainParams</code>.</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 the trainer type could not be determined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEventModelSequenceTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)"> |
| <h3>getEventModelSequenceTrainer</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml">EventModelSequenceTrainer</a><T></span> <span class="element-name">getEventModelSequenceTrainer</span><wbr><span class="parameters">(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</span></div> |
| <div class="block">Retrieves an <a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml"><code>EventModelSequenceTrainer</code></a> that fits the given parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to check for the trainer type. |
| Note: The entry <a href="AbstractTrainer.html#ALGORITHM_PARAM"><code>AbstractTrainer.ALGORITHM_PARAM</code></a> is used |
| to determine the type.</dd> |
| <dd><code>reportMap</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>Map</code></a> that shall be used during initialization of |
| the <a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml"><code>EventModelSequenceTrainer</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid <a href="EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml"><code>EventModelSequenceTrainer</code></a> for the configured <code>trainParams</code>.</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 the trainer type could not be determined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEventTrainer(opennlp.tools.util.TrainingParameters,java.util.Map)"> |
| <h3>getEventTrainer</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="EventTrainer.html" title="interface in opennlp.tools.ml">EventTrainer</a></span> <span class="element-name">getEventTrainer</span><wbr><span class="parameters">(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> 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><<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>> reportMap)</span></div> |
| <div class="block">Retrieves an <a href="EventTrainer.html" title="interface in opennlp.tools.ml"><code>EventTrainer</code></a> that fits the given parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to check for the trainer type. |
| Note: The entry <a href="AbstractTrainer.html#ALGORITHM_PARAM"><code>AbstractTrainer.ALGORITHM_PARAM</code></a> is used |
| to determine the type. If the type is not defined, the |
| <a href="maxent/GISTrainer.html#MAXENT_VALUE"><code>GISTrainer.MAXENT_VALUE</code></a> will be used.</dd> |
| <dd><code>reportMap</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>Map</code></a> that shall be used during initialization of |
| the <a href="EventTrainer.html" title="interface in opennlp.tools.ml"><code>EventTrainer</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>A valid <a href="EventTrainer.html" title="interface in opennlp.tools.ml"><code>EventTrainer</code></a> for the configured <code>trainParams</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(opennlp.tools.util.TrainingParameters)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="../util/TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainParams)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trainParams</code> - The <a href="../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> to validate. Must not be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the <code>trainParams</code> could be validated, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |