| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>opennlp.tools.ml.model (Apache OpenNLP Tools 2.3.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: opennlp.tools.ml.model"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package opennlp.tools.ml.model" class="title">Package opennlp.tools.ml.model</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">opennlp.tools.ml.model</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Package related to ML models and feature selection techniques.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">opennlp.tools.ml</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Package related to Machine Learning (ML) features of OpenNLP, the related ML models, and trainers.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../maxent/package-summary.html">opennlp.tools.ml.maxent</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Package related to ML by means of the Maximum Entropy (ME) algorithm.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../naivebayes/package-summary.html">opennlp.tools.ml.naivebayes</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Package related to ML by means of the Naive Bayes algorithm.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../perceptron/package-summary.html">opennlp.tools.ml.perceptron</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Package related to ML by means of the perceptron algorithm.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractDataIndexer.html" title="class in opennlp.tools.ml.model">AbstractDataIndexer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract <a href="DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a> implementation for collecting |
| event and context counts used in training.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A basic <a href="MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a> implementation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="AbstractModel.ModelType.html" title="enum class in opennlp.tools.ml.model">AbstractModel.ModelType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractModelReader.html" title="class in opennlp.tools.ml.model">AbstractModelReader</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An abstract, basic implementation of a model reader.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractModelWriter.html" title="class in opennlp.tools.ml.model">AbstractModelWriter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An abstract, basic implementation of a model writer.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BinaryFileDataReader.html" title="class in opennlp.tools.ml.model">BinaryFileDataReader</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="DataReader.html" title="interface in opennlp.tools.ml.model"><code>DataReader</code></a> that reads files from a binary format.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ComparableEvent.html" title="class in opennlp.tools.ml.model">ComparableEvent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A maxent event representation which we can use to sort based on the |
| predicates indexes contained in the events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ComparablePredicate.html" title="class in opennlp.tools.ml.model">ComparablePredicate</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A maxent predicate representation which we can use to sort based on the |
| outcomes.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Context.html" title="class in opennlp.tools.ml.model">Context</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Class which associates a real valued parameter or expected value with a particular contextual |
| predicate or feature.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataIndexer.html" title="interface in opennlp.tools.ml.model">DataIndexer</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents an indexer which compresses events in memory and performs feature selection.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DataIndexerFactory.html" title="class in opennlp.tools.ml.model">DataIndexerFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A factory that produces <a href="DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a> instances.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataReader.html" title="interface in opennlp.tools.ml.model">DataReader</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Describes generic ways to read data from a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInputStream.html" title="class or interface in java.io" class="external-link"><code>DataInputStream</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DynamicEvalParameters.html" title="class in opennlp.tools.ml.model">DynamicEvalParameters</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EvalParameters.html" title="class in opennlp.tools.ml.model">EvalParameters</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">This class encapsulates the variables used in producing probabilities from a model |
| and facilitates passing these variables to the eval method.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Event.html" title="class in opennlp.tools.ml.model">Event</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The context of a decision point during training.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="FileEventStream.html" title="class in opennlp.tools.ml.model">FileEventStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Class for using a file of <a href="Event.html" title="class in opennlp.tools.ml.model"><code>events</code></a> as an <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>event stream</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GenericModelReader.html" title="class in opennlp.tools.ml.model">GenericModelReader</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An generic <a href="AbstractModelReader.html" title="class in opennlp.tools.ml.model"><code>AbstractModelReader</code></a> implementation.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GenericModelWriter.html" title="class in opennlp.tools.ml.model">GenericModelWriter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An generic <a href="AbstractModelWriter.html" title="class in opennlp.tools.ml.model"><code>AbstractModelWriter</code></a> implementation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="HashSumEventStream.html" title="class in opennlp.tools.ml.model">HashSumEventStream</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A hash sum based <a href="../../util/AbstractObjectStream.html" title="class in opennlp.tools.util"><code>AbstractObjectStream</code></a> implementation.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for maximum entropy models.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ModelParameterChunker.html" title="class in opennlp.tools.ml.model">ModelParameterChunker</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A helper class that handles Strings with more than 64k (65535 bytes) in length.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MutableContext.html" title="class in opennlp.tools.ml.model">MutableContext</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An extension of <a href="Context.html" title="class in opennlp.tools.ml.model"><code>Context</code></a> used to store parameters or expected values |
| associated with this context which can be updated or assigned.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ObjectDataReader.html" title="class in opennlp.tools.ml.model">ObjectDataReader</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="DataReader.html" title="interface in opennlp.tools.ml.model"><code>DataReader</code></a> implementation based on <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/ObjectInputStream.html" title="class or interface in java.io" class="external-link"><code>ObjectInputStream</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OnePassDataIndexer.html" title="class in opennlp.tools.ml.model">OnePassDataIndexer</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a> for maxent model data which handles cutoffs for uncommon |
| contextual predicates and provides a unique integer index for each of the |
| predicates.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="OnePassRealValueDataIndexer.html" title="class in opennlp.tools.ml.model">OnePassRealValueDataIndexer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a> for maxent model data which handles cutoffs for uncommon |
| contextual predicates and provides a unique integer index for each of the |
| predicates and maintains event values.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PlainTextFileDataReader.html" title="class in opennlp.tools.ml.model">PlainTextFileDataReader</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A generic <a href="DataReader.html" title="interface in opennlp.tools.ml.model"><code>DataReader</code></a> implementation for plain text files.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Prior.html" title="interface in opennlp.tools.ml.model">Prior</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">This interface allows one to implement a prior distribution for use in |
| maximum entropy model training.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RealValueFileEventStream.html" title="class in opennlp.tools.ml.model">RealValueFileEventStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Class for using a file of real-valued <a href="Event.html" title="class in opennlp.tools.ml.model"><code>events</code></a> as an |
| <a href="../../util/ObjectStream.html" title="interface in opennlp.tools.util"><code>event stream</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Sequence.html" title="class in opennlp.tools.ml.model">Sequence</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Class which models a sequence.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A classification model that can label an input <a href="../../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a><S></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for streams of <a href="Sequence.html" title="class in opennlp.tools.ml.model"><code>sequences</code></a> used to train sequence models.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SequenceStreamEventStream.html" title="class in opennlp.tools.ml.model">SequenceStreamEventStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Class which turns a <a href="SequenceStream.html" title="interface in opennlp.tools.ml.model"><code>SequenceStream</code></a> into an event stream.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TwoPassDataIndexer.html" title="class in opennlp.tools.ml.model">TwoPassDataIndexer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Collecting event and context counts by making two passes over the events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="UniformPrior.html" title="class in opennlp.tools.ml.model">UniformPrior</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Provide a maximum entropy model with a uniform <a href="Prior.html" title="interface in opennlp.tools.ml.model"><code>Prior</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
