| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:11:36 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HmmTrainer (Mahout Map-Reduce 0.13.0 API)</title> |
| <meta name="date" content="2017-04-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HmmTrainer (Mahout Map-Reduce 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HmmTrainer.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmUtils.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html" target="_top">Frames</a></li> |
| <li><a href="HmmTrainer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mahout.classifier.sequencelearning.hmm</div> |
| <h2 title="Class HmmTrainer" class="title">Class HmmTrainer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mahout.classifier.sequencelearning.hmm.HmmTrainer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">HmmTrainer</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Class containing several algorithms used to train a Hidden Markov Model. The |
| three main algorithms are: supervised learning, unsupervised Viterbi and |
| unsupervised Baum-Welch.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html#trainBaumWelch-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-int:A-double-int-boolean-">trainBaumWelch</a></span>(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> initialModel, |
| int[] observedSequence, |
| double epsilon, |
| int maxIterations, |
| boolean scaled)</code> |
| <div class="block">Iteratively train the parameters of the given initial model wrt the |
| observed sequence using Baum-Welch training.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html#trainSupervised-int-int-int:A-int:A-double-">trainSupervised</a></span>(int nrOfHiddenStates, |
| int nrOfOutputStates, |
| int[] observedSequence, |
| int[] hiddenSequence, |
| double pseudoCount)</code> |
| <div class="block">Create an supervised initial estimate of an HMM Model based on a sequence |
| of observed and hidden states.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html#trainSupervisedSequence-int-int-java.util.Collection-java.util.Collection-double-">trainSupervisedSequence</a></span>(int nrOfHiddenStates, |
| int nrOfOutputStates, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><int[]> hiddenSequences, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><int[]> observedSequences, |
| double pseudoCount)</code> |
| <div class="block">Create an supervised initial estimate of an HMM Model based on a number of |
| sequences of observed and hidden states.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html#trainViterbi-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-int:A-double-double-int-boolean-">trainViterbi</a></span>(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> initialModel, |
| int[] observedSequence, |
| double pseudoCount, |
| double epsilon, |
| int maxIterations, |
| boolean scaled)</code> |
| <div class="block">Iteratively train the parameters of the given initial model wrt to the |
| observed sequence using Viterbi training.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="trainSupervised-int-int-int:A-int:A-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trainSupervised</h4> |
| <pre>public static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> trainSupervised(int nrOfHiddenStates, |
| int nrOfOutputStates, |
| int[] observedSequence, |
| int[] hiddenSequence, |
| double pseudoCount)</pre> |
| <div class="block">Create an supervised initial estimate of an HMM Model based on a sequence |
| of observed and hidden states.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nrOfHiddenStates</code> - The total number of hidden states</dd> |
| <dd><code>nrOfOutputStates</code> - The total number of output states</dd> |
| <dd><code>observedSequence</code> - Integer array containing the observed sequence</dd> |
| <dd><code>hiddenSequence</code> - Integer array containing the hidden sequence</dd> |
| <dd><code>pseudoCount</code> - Value that is assigned to non-occurring transitions to avoid zero |
| probabilities.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An initial model using the estimated parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trainSupervisedSequence-int-int-java.util.Collection-java.util.Collection-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trainSupervisedSequence</h4> |
| <pre>public static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> trainSupervisedSequence(int nrOfHiddenStates, |
| int nrOfOutputStates, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><int[]> hiddenSequences, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><int[]> observedSequences, |
| double pseudoCount)</pre> |
| <div class="block">Create an supervised initial estimate of an HMM Model based on a number of |
| sequences of observed and hidden states.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nrOfHiddenStates</code> - The total number of hidden states</dd> |
| <dd><code>nrOfOutputStates</code> - The total number of output states</dd> |
| <dd><code>hiddenSequences</code> - Collection of hidden sequences to use for training</dd> |
| <dd><code>observedSequences</code> - Collection of observed sequences to use for training associated with hidden sequences.</dd> |
| <dd><code>pseudoCount</code> - Value that is assigned to non-occurring transitions to avoid zero |
| probabilities.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An initial model using the estimated parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trainViterbi-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-int:A-double-double-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trainViterbi</h4> |
| <pre>public static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> trainViterbi(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> initialModel, |
| int[] observedSequence, |
| double pseudoCount, |
| double epsilon, |
| int maxIterations, |
| boolean scaled)</pre> |
| <div class="block">Iteratively train the parameters of the given initial model wrt to the |
| observed sequence using Viterbi training.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialModel</code> - The initial model that gets iterated</dd> |
| <dd><code>observedSequence</code> - The sequence of observed states</dd> |
| <dd><code>pseudoCount</code> - Value that is assigned to non-occurring transitions to avoid zero |
| probabilities.</dd> |
| <dd><code>epsilon</code> - Convergence criteria</dd> |
| <dd><code>maxIterations</code> - The maximum number of training iterations</dd> |
| <dd><code>scaled</code> - Use Log-scaled implementation, this is computationally more |
| expensive but offers better numerical stability for large observed |
| sequences</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The iterated model</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trainBaumWelch-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-int:A-double-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>trainBaumWelch</h4> |
| <pre>public static <a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> trainBaumWelch(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a> initialModel, |
| int[] observedSequence, |
| double epsilon, |
| int maxIterations, |
| boolean scaled)</pre> |
| <div class="block">Iteratively train the parameters of the given initial model wrt the |
| observed sequence using Baum-Welch training.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialModel</code> - The initial model that gets iterated</dd> |
| <dd><code>observedSequence</code> - The sequence of observed states</dd> |
| <dd><code>epsilon</code> - Convergence criteria</dd> |
| <dd><code>maxIterations</code> - The maximum number of training iterations</dd> |
| <dd><code>scaled</code> - Use log-scaled implementations of forward/backward algorithm. This |
| is computationally more expensive, but offers better numerical |
| stability for long output sequences.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The iterated model</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HmmTrainer.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmUtils.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html" target="_top">Frames</a></li> |
| <li><a href="HmmTrainer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |