qminer
Version:
A C++ based data analytics platform for processing large-scale real-time streams containing structured and unstructured data
222 lines (218 loc) • 8.4 kB
HTML
<html>
<head>
<meta name="generator" content="JSDoc 3">
<meta charset="utf-8">
<title>Class: Binarizer</title>
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
<link href="css/baseline.css" rel="stylesheet">
</head>
<body onload="prettyPrint()">
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content">
<a href="index.html" class="jsdoc-navbar-package-name">QMiner JavaScript API v9.4.0</a>
</div>
</div>
</nav>
<div id="jsdoc-body-container">
<div id="jsdoc-content">
<div id="jsdoc-content-container">
<div id="jsdoc-main" role="main">
<header class="page-header">
<div class="symbol-detail-labels"><span class="label label-kind">class</span> <span class="label label-static">static</span></div>
<h1><small><a href="module-analytics.html">analytics</a>~<wbr><a href="module-analytics-preprocessing.html">preprocessing</a>.<wbr></small><span class="symbol-name">Binarizer</span></h1>
<p class="source-link">Source: <a href="analyticsdoc.js.html#source-line-2947">analyticsdoc.<wbr>js:2947</a></p>
<div class="symbol-classdesc">
<p>Transform given array of labels into binary vector with different
numeric value for elements when label matches specified label and
for other elements. By default, these values are +1 for matching
labels, and -1 for the rest.</p>
</div>
<dl class="dl-compact">
</dl>
</header>
<section id="summary">
<div class="summary-callout">
<h2 class="summary-callout-heading">Method</h2>
<div class="summary-content">
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics-preprocessing.Binarizer.html#transform">transform(y)</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
</div>
<div class="summary-column">
</div>
</div>
</div>
</section>
<section>
<h2 id="Binarizer">new <span class="symbol-name">Binarizer</span><span class="signature"><span class="signature-params">(y, positiveLabel[, positiveId][, negativeId])</span></span></h2>
<p>Transforming arrays with labels to vector appropriate for binary classifiers.</p>
<section>
<h3>
Example
</h3>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create binarizer with 'b' as positive label
var binarizer = new analytics.preprocessing.Binarizer('b');</code></pre>
</div>
</section>
<section>
<h3>Parameters</h3>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>y</p>
</td>
<td>
<p>Array</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>Labels.</p>
</td>
</tr>
<tr>
<td>
<p>positiveLabel</p>
</td>
<td>
<p>(string or number)</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>Positive label.</p>
</td>
</tr>
<tr>
<td>
<p>positiveId</p>
</td>
<td>
<p>number</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Value when matching positive label.</p>
<p>Defaults to <code>1</code>.</p>
</td>
</tr>
<tr>
<td>
<p>negativeId</p>
</td>
<td>
<p>number</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Value when not matching positive label.</p>
<p>Defaults to <code>-1</code>.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
</dl>
</section>
<section>
<h2>Method</h2>
<section>
<h3 id="transform"><span class="symbol-name">transform</span><span class="signature"><span class="signature-params">(y)</span> → <span class="signature-returns"> modul:la.Vector</span></span></h3>
<p>Transform given array of labels to binary numeric vector.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create binarizer with 'b' as positive label
var binarizer = new analytics.preprocessing.Binarizer('b');
// get vector with binarized labels
var bins = binarizer.transform(['a','b','a','c']);</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>y</p>
</td>
<td>
<p>(Array of number, Array of string, <a href="module-la.Vector.html">module:la.Vector</a>, or <a href="module-la.StrVector.html">module:la.StrVector</a>)</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>Labels.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>modul:la.Vector</code>B Binarized vector.</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
<nav id="jsdoc-toc-nav" role="navigation"></nav>
</div>
</div>
<footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container">
<p>
</p>
</div>
</footer>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tree.jquery.js"></script>
<script src="scripts/prettify.js"></script>
<script src="scripts/jsdoc-toc.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/scrollanchor.js"></script>
</body>
</html>