docs/Perceptron.html

<!DOCTYPE html>
<html lang="en">
<head>
    
    <meta charset="utf-8">
    <title>Perceptron - Documentation</title>
    
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
    
    <h2><a href="index.html">Home</a></h2><h2><a href="http://winkjs.org" target="_blank" >Wink JS</a></h2><h2><a href="https://github.com/winkjs/wink-perceptron" target="_blank" >Github</a></h2><h3>Classes</h3><ul><li><a href="Perceptron.html">Perceptron</a><ul class='methods'><li data-type='method'><a href="Perceptron.html#defineConfig">defineConfig</a></li><li data-type='method'><a href="Perceptron.html#learn">learn</a></li><li data-type='method'><a href="Perceptron.html#predict">predict</a></li><li data-type='method'><a href="Perceptron.html#reset">reset</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#perceptron">perceptron</a></li></ul>
</nav>

<div id="main">
    
    <h1 class="page-title">Perceptron</h1>
    

<section>

<header>
    
        <h2>
        Perceptron
        </h2>
        
            <div class="class-description"><p>Multi-class Averaged Perceptron  class.</p></div>
        
    
</header>

<article>
    

        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="defineConfig"><span class="type-signature"></span>defineConfig<span class="signature">(config)</span><span class="type-signature"> &rarr; {object}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="wink-perceptron.js.html">wink-perceptron.js</a>, <a href="wink-perceptron.js.html#line316">line 316</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    <p>Defines the hyperparameters for perceptron.</p>
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>// Enable random shuffling of examples!
myPerceptron.defineConfig( { shuffleData: true } );
// -> { shuffleData: true, maxIterations: 9, featureExtractor: null }</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>config</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last"><p>table below details the properties of <code>config</code> object.</p>
<p><em>An empty config object restores the default configuration.</em></p>
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>shuffleData</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>false</code>
                
                </td>
            

            <td class="description last"><p>determines whether or not the
training examples should be randomly shuffled after each iteration a.k.a epoch.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>maxIterations</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>9</code>
                
                </td>
            

            <td class="description last"><p>number of passes that must be made
over the examples in order to complete the learning.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>featureExtractor</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>null</code>
                
                </td>
            

            <td class="description last"><p>extracts feature(s) along with the corresponding class label(s)
from example prior to each iteration. This is useful when raw examples need to be
passed to <a href="#learn"><code>learn()</code></a> instead of features &amp; labels. If it extracts &gt;1 features
then each of the extracted feature/label pair is processed sequentially during learning.
Note <code>shuffleData</code> value will only control the shuffling of input examples and
not of the extracted features with this function.</p></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A copy of configuration defined.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    
    <h4 class="name" id="learn"><span class="type-signature"></span>learn<span class="signature">(examples)</span><span class="type-signature"> &rarr; {number}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="wink-perceptron.js.html">wink-perceptron.js</a>, <a href="wink-perceptron.js.html#line259">line 259</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    <p>Learns from the <strong>examples</strong>. The hyperparameters, defined via <a href="#defineConfig"><code>defineConfig</code></a>,
control learning process.</p>
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>myPerceptron.learn( examples );</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>examples</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;array></span>


            </td>

            
            <td class="description last"><p>each example is a 2-element array. The
first element describes example's features and the second one defines
its class label. Both of these are expressed in form of an object. The
features object contains <strong>name/numeric-value</strong> pairs for every feature, whereas the
class label contains single name/string-value pair as <code>{ label: &lt;class&gt; }</code>.</p></td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        <p>Error if all <code>examples</code> belong to only a single class.</p>
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Number of examples passed.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>


    </dd>
</dl>

    
    <h4 class="name" id="predict"><span class="type-signature"></span>predict<span class="signature">(features)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="wink-perceptron.js.html">wink-perceptron.js</a>, <a href="wink-perceptron.js.html#line292">line 292</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    <p>Predicts the label for the input <code>features</code>. If it is unable to predict then
it returns a value <strong><code>unknown</code></strong>.</p>
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>myPerceptron.predict( features );</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>features</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last"><p>object that contains <strong>name/value</strong> pairs for every
feature.</p></td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        <p>Error if prediction is attempted without <a href="#learn">learning</a>.</p>
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Predicted class label for the input <code>features</code>.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="wink-perceptron.js.html">wink-perceptron.js</a>, <a href="wink-perceptron.js.html#line363">line 363</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    <p>It completely resets the perceptron by re-initializing all the learning
related variables but does not touch the existing configuration.</p>
<p><em>Since it does not reset the existing configuration, user must define it
again prior to learning if required.</em></p>
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>myPerceptron.reset();
// -> true</code></pre>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Always true.</p>
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 19 2018 19:13:50 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>


</body>
</html>