| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TrainingParameters (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.util, class: TrainingParameters"> |
| <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>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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.util</a></div> |
| <h1 title="Class TrainingParameters" class="title">Class TrainingParameters</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.util.TrainingParameters</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">TrainingParameters</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">Declares and handles default parameters used for or during training models.</div> |
| </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 <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="#ALGORITHM_PARAM" class="member-name-link">ALGORITHM_PARAM</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#CUTOFF_DEFAULT_VALUE" class="member-name-link">CUTOFF_DEFAULT_VALUE</a></code></div> |
| <div class="col-last odd-row-color"> </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="#CUTOFF_PARAM" class="member-name-link">CUTOFF_PARAM</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#ITERATIONS_DEFAULT_VALUE" class="member-name-link">ITERATIONS_DEFAULT_VALUE</a></code></div> |
| <div class="col-last odd-row-color"> </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="#ITERATIONS_PARAM" class="member-name-link">ITERATIONS_PARAM</a></code></div> |
| <div class="col-last even-row-color"> </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="#THREADS_PARAM" class="member-name-link">THREADS_PARAM</a></code></div> |
| <div class="col-last odd-row-color"> </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="#TRAINER_TYPE_PARAM" class="member-name-link">TRAINER_TYPE_PARAM</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">TrainingParameters</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">No-arg constructor to create a default <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.io.InputStream)" class="member-name-link">TrainingParameters</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> based constructor that reads in <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a>.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map)" class="member-name-link">TrainingParameters</a><wbr>(<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> map)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Key-value based constructor to apply 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> based configuration initialization.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(opennlp.tools.util.TrainingParameters)" class="member-name-link">TrainingParameters</a><wbr>(<a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainingParameters)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Copy constructor to hand over the config of existing <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</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-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-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="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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#algorithm()" class="member-name-link">algorithm</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#algorithm(java.lang.String)" class="member-name-link">algorithm</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> namespace)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#defaultParams()" class="member-name-link">defaultParams</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBooleanParameter(java.lang.String,boolean)" class="member-name-link">getBooleanParameter</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> key, |
| boolean defaultValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value.</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="#getBooleanParameter(java.lang.String,java.lang.String,boolean)" class="member-name-link">getBooleanParameter</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> namespace, |
| <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> key, |
| boolean defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value in the specified namespace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDoubleParameter(java.lang.String,double)" class="member-name-link">getDoubleParameter</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> key, |
| double defaultValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDoubleParameter(java.lang.String,java.lang.String,double)" class="member-name-link">getDoubleParameter</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> namespace, |
| <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> key, |
| double defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value in the specified namespace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIntParameter(java.lang.String,int)" class="member-name-link">getIntParameter</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> key, |
| int defaultValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIntParameter(java.lang.String,java.lang.String,int)" class="member-name-link">getIntParameter</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> namespace, |
| <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> key, |
| int defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value in the specified namespace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectSettings()" class="member-name-link">getObjectSettings</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectSettings(java.lang.String)" class="member-name-link">getObjectSettings</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> namespace)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameters(java.lang.String)" class="member-name-link">getParameters</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> namespace)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStringParameter(java.lang.String,java.lang.String)" class="member-name-link">getStringParameter</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> key, |
| <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> defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStringParameter(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getStringParameter</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> namespace, |
| <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> key, |
| <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> defaultValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Obtains a training parameter value in the specified namespace.</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="#put(java.lang.String,boolean)" class="member-name-link">put</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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</div> |
| </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="#put(java.lang.String,double)" class="member-name-link">put</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> key, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</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="#put(java.lang.String,int)" class="member-name-link">put</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> key, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</div> |
| </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="#put(java.lang.String,java.lang.String)" class="member-name-link">put</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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</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="#put(java.lang.String,java.lang.String,boolean)" class="member-name-link">put</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> namespace, |
| <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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</div> |
| </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="#put(java.lang.String,java.lang.String,double)" class="member-name-link">put</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> namespace, |
| <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> key, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</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="#put(java.lang.String,java.lang.String,int)" class="member-name-link">put</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> namespace, |
| <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> key, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</div> |
| </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="#put(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">put</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> namespace, |
| <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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>.</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="#putIfAbsent(java.lang.String,boolean)" class="member-name-link">putIfAbsent</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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| </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="#putIfAbsent(java.lang.String,double)" class="member-name-link">putIfAbsent</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> key, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</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="#putIfAbsent(java.lang.String,int)" class="member-name-link">putIfAbsent</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> key, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| </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="#putIfAbsent(java.lang.String,java.lang.String)" class="member-name-link">putIfAbsent</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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</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="#putIfAbsent(java.lang.String,java.lang.String,boolean)" class="member-name-link">putIfAbsent</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> namespace, |
| <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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| </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="#putIfAbsent(java.lang.String,java.lang.String,double)" class="member-name-link">putIfAbsent</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> namespace, |
| <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> key, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</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="#putIfAbsent(java.lang.String,java.lang.String,int)" class="member-name-link">putIfAbsent</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> namespace, |
| <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> key, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| </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="#putIfAbsent(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">putIfAbsent</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> namespace, |
| <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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</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="#serialize(java.io.OutputStream)" class="member-name-link">serialize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> out)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Serializes a <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance via a specified <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link"><code>OutputStream</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setParams(java.lang.String%5B%5D)" class="member-name-link">setParams</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>[] params)</code></div> |
| <div class="col-last odd-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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ALGORITHM_PARAM"> |
| <h3>ALGORITHM_PARAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name">ALGORITHM_PARAM</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.ALGORITHM_PARAM">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TRAINER_TYPE_PARAM"> |
| <h3>TRAINER_TYPE_PARAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name">TRAINER_TYPE_PARAM</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.TRAINER_TYPE_PARAM">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ITERATIONS_PARAM"> |
| <h3>ITERATIONS_PARAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name">ITERATIONS_PARAM</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.ITERATIONS_PARAM">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CUTOFF_PARAM"> |
| <h3>CUTOFF_PARAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name">CUTOFF_PARAM</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.CUTOFF_PARAM">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> <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> <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.util.TrainingParameters.THREADS_PARAM">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ITERATIONS_DEFAULT_VALUE"> |
| <h3>ITERATIONS_DEFAULT_VALUE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">ITERATIONS_DEFAULT_VALUE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.ITERATIONS_DEFAULT_VALUE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CUTOFF_DEFAULT_VALUE"> |
| <h3>CUTOFF_DEFAULT_VALUE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">CUTOFF_DEFAULT_VALUE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../constant-values.html#opennlp.tools.util.TrainingParameters.CUTOFF_DEFAULT_VALUE">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="<init>()"> |
| <h3>TrainingParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrainingParameters</span>()</div> |
| <div class="block">No-arg constructor to create a default <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(opennlp.tools.util.TrainingParameters)"> |
| <h3>TrainingParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrainingParameters</span><wbr><span class="parameters">(<a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a> trainingParameters)</span></div> |
| <div class="block">Copy constructor to hand over the config of existing <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Map)"> |
| <h3>TrainingParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrainingParameters</span><wbr><span class="parameters">(<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> map)</span></div> |
| <div class="block">Key-value based constructor to apply 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> based configuration initialization.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.io.InputStream)"> |
| <h3>TrainingParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrainingParameters</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in)</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> |
| <div class="block"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> based constructor that reads in <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a>.</div> |
| <dl class="notes"> |
| <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> - Thrown if IO errors occurred.</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="algorithm(java.lang.String)"> |
| <h3>algorithm</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">algorithm</span><wbr><span class="parameters">(<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> namespace)</span></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the training algorithm name for a given name space, or <code>null</code> if unset.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="algorithm()"> |
| <h3>algorithm</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">algorithm</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the training algorithm name. or @code null} if not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectSettings(java.lang.String)"> |
| <h3>getObjectSettings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getObjectSettings</span><wbr><span class="parameters">(<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> namespace)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The name space to filter or narrow the search space. May be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>Retrieves a parameter <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> which can be passed to the train and validate methods.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectSettings()"> |
| <h3>getObjectSettings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getObjectSettings</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves a parameter <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> of all parameters without narrowing.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParameters(java.lang.String)"> |
| <h3>getParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></span> <span class="element-name">getParameters</span><wbr><span class="parameters">(<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> namespace)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The name space to filter or narrow the search space. May be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>Retrieves <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> which can be passed to the train and validate methods.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| <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> value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <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"><code>String</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,java.lang.String)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> key, |
| <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> value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <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"><code>String</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,java.lang.String,int)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| int value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,int)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> key, |
| int value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,java.lang.String,double)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| double value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,double)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> key, |
| double value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,java.lang.String,boolean)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| boolean value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putIfAbsent(java.lang.String,boolean)"> |
| <h3>putIfAbsent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">putIfAbsent</span><wbr><span class="parameters">(<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> key, |
| boolean value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>, |
| if the value was not present before.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| <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> value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <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"><code>String</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,java.lang.String)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> key, |
| <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> value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <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"><code>String</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,java.lang.String,int)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| int value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,int)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> key, |
| int value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,java.lang.String,double)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| double value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,double)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> key, |
| double value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,java.lang.String,boolean)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| boolean value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one. |
| The <code>namespace</code> can be used to prefix the <code>key</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be put. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.lang.String,boolean)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<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> key, |
| boolean value)</span></div> |
| <div class="block">Puts a <code>value</code> into the current <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> under a certain <code>key</code>. |
| If the value was present before, the previous value will be overwritten with the specified one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to put or retrieve a <code>value</code> with.</dd> |
| <dd><code>value</code> - The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a> parameter to put into this <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serialize(java.io.OutputStream)"> |
| <h3>serialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">serialize</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> out)</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> |
| <div class="block">Serializes a <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>TrainingParameters</code></a> instance via a specified <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link"><code>OutputStream</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>out</code> - A valid, open <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link"><code>OutputStream</code></a> to write to.</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> - Thrown if errors occurred.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringParameter(java.lang.String,java.lang.String)"> |
| <h3>getStringParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getStringParameter</span><wbr><span class="parameters">(<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> key, |
| <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> defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value. |
| <p> |
| Note: |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link"><code>ClassCastException</code></a> can be thrown if the value is not <code>String</code></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <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"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringParameter(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>getStringParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getStringParameter</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| <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> defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value in the specified namespace. |
| <p> |
| Note: |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link"><code>ClassCastException</code></a> can be thrown if the value is not <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"><code>String</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be searched. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <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"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIntParameter(java.lang.String,int)"> |
| <h3>getIntParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getIntParameter</span><wbr><span class="parameters">(<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> key, |
| int defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIntParameter(java.lang.String,java.lang.String,int)"> |
| <h3>getIntParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getIntParameter</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| int defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value in the specified namespace. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be searched. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDoubleParameter(java.lang.String,double)"> |
| <h3>getDoubleParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getDoubleParameter</span><wbr><span class="parameters">(<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> key, |
| double defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDoubleParameter(java.lang.String,java.lang.String,double)"> |
| <h3>getDoubleParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getDoubleParameter</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| double defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value in the specified namespace. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be searched. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBooleanParameter(java.lang.String,boolean)"> |
| <h3>getBooleanParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getBooleanParameter</span><wbr><span class="parameters">(<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> key, |
| boolean defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBooleanParameter(java.lang.String,java.lang.String,boolean)"> |
| <h3>getBooleanParameter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getBooleanParameter</span><wbr><span class="parameters">(<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> namespace, |
| <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> key, |
| boolean defaultValue)</span></div> |
| <div class="block">Obtains a training parameter value in the specified namespace. |
| <p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - A prefix to declare or use a name space under which <code>key</code> shall be searched. |
| May be <code>null</code>.</dd> |
| <dd><code>key</code> - The identifying key to retrieve a <code>value</code> with.</dd> |
| <dd><code>defaultValue</code> - The alternative value to use, if <code>key</code> was not present.</dd> |
| <dt>Returns:</dt> |
| <dd>The <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>training value</code></a> associated with <code>key</code> if present, |
| or a <code>defaultValue</code> if not.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultParams()"> |
| <h3>defaultParams</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></span> <span class="element-name">defaultParams</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves a new <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>instance</code></a> initialized with default values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParams(java.lang.String[])"> |
| <h3>setParams</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></span> <span class="element-name">setParams</span><wbr><span class="parameters">(<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>[] params)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>params</code> - The parameters to additionally apply into the new <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>instance</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>Retrieves a new <a href="TrainingParameters.html" title="class in opennlp.tools.util"><code>instance</code></a> initialized with given parameter values.</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> |