Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / pmml / runner / PmmlModelRunner.html
blob: 9395a40188a3b1d1e4a1de501c8b31fe82811d01 [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PmmlModelRunner (Storm 2.4.0 API)</title>
<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="PmmlModelRunner (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PmmlModelRunner.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/storm/pmml/runner/ModelRunnerFactory.html" title="interface in org.apache.storm.pmml.runner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/pmml/runner/PmmlModelRunner.html" target="_top">Frames</a></li>
<li><a href="PmmlModelRunner.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.storm.pmml.runner</div>
<h2 title="Interface PmmlModelRunner" class="title">Interface PmmlModelRunner&lt;I,R,P,S&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/storm/pmml/runner/ModelRunner.html" title="interface in org.apache.storm.pmml.runner">ModelRunner</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/storm/pmml/runner/jpmml/JPmmlModelRunner.html" title="class in org.apache.storm.pmml.runner.jpmml">JPmmlModelRunner</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PmmlModelRunner&lt;I,R,P,S&gt;</span>
extends <a href="../../../../../org/apache/storm/pmml/runner/ModelRunner.html" title="interface in org.apache.storm.pmml.runner">ModelRunner</a></pre>
<div class="block"><p>Runner for models defined using PMML.</p></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html#extractRawInputs-I-">extractRawInputs</a></span>(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">I</a>&nbsp;input)</code>
<div class="block">Extracts from the tuple the raw inputs that are to be scored according to the predictive model.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">S</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html#predictScores-P-">predictScores</a></span>(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">P</a>&nbsp;preProcInputs)</code>
<div class="block">Compute the predicted scores from the pre-processed inputs in the step above.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">P</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html#preProcessInputs-R-">preProcessInputs</a></span>(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">R</a>&nbsp;rawInputs)</code>
<div class="block">Pre process inputs, i.e., remove missing fields, outliers, etc</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.pmml.runner.ModelRunner">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.pmml.runner.<a href="../../../../../org/apache/storm/pmml/runner/ModelRunner.html" title="interface in org.apache.storm.pmml.runner">ModelRunner</a></h3>
<code><a href="../../../../../org/apache/storm/pmml/runner/ModelRunner.html#scoredTuplePerStream-org.apache.storm.tuple.Tuple-">scoredTuplePerStream</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="extractRawInputs-java.lang.Object-">
<!-- -->
</a><a name="extractRawInputs-I-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractRawInputs</h4>
<pre><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">R</a>&nbsp;extractRawInputs(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">I</a>&nbsp;input)</pre>
<div class="block"><p>Extracts from the tuple the raw inputs that are to be scored according to the predictive model.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - source from which to extract raw inputs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>raw inputs</dd>
</dl>
</li>
</ul>
<a name="preProcessInputs-java.lang.Object-">
<!-- -->
</a><a name="preProcessInputs-R-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preProcessInputs</h4>
<pre><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">P</a>&nbsp;preProcessInputs(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">R</a>&nbsp;rawInputs)</pre>
<div class="block"><p>Pre process inputs, i.e., remove missing fields, outliers, etc</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rawInputs</code> - that are to be preprocessed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>preprocessed output</dd>
</dl>
</li>
</ul>
<a name="predictScores-java.lang.Object-">
<!-- -->
</a><a name="predictScores-P-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>predictScores</h4>
<pre><a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">S</a>&nbsp;predictScores(<a href="../../../../../org/apache/storm/pmml/runner/PmmlModelRunner.html" title="type parameter in PmmlModelRunner">P</a>&nbsp;preProcInputs)</pre>
<div class="block"><p>Compute the predicted scores from the pre-processed inputs in the step above.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preProcInputs</code> - that are to be preprocessed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>predicted scores</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/PmmlModelRunner.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/storm/pmml/runner/ModelRunnerFactory.html" title="interface in org.apache.storm.pmml.runner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/pmml/runner/PmmlModelRunner.html" target="_top">Frames</a></li>
<li><a href="PmmlModelRunner.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>