blob: f6bec70b1449bd72c1faa42dd0e74353a1218771 [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>engine - PredictionIO Scala API 0.14.0 - org.apache.predictionio.e2.engine</title>
<meta name="description" content="engine - PredictionIO Scala API 0.14.0 - org.apache.predictionio.e2.engine" />
<meta name="keywords" content="engine PredictionIO Scala API 0.14.0 org.apache.predictionio.e2.engine" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../../index.html';
var hash = 'org.apache.predictionio.e2.engine.package';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="value">
<div id="definition">
<img alt="Package" src="../../../../../lib/package_big.png" />
<p id="owner"><a href="../../../../package.html" class="extype" name="org">org</a>.<a href="../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../package.html" class="extype" name="org.apache.predictionio">predictionio</a>.<a href="../package.html" class="extype" name="org.apache.predictionio.e2">e2</a></p>
<h1>engine</h1><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<span class="name">engine</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Collection of engine libraries that have no dependency on PredictionIO</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By Inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="org.apache.predictionio.e2.engine"><span>engine</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show All</span></li>
</ol>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="types" class="types members">
<h3>Type Members</h3>
<ol><li name="org.apache.predictionio.e2.engine.BinaryVectorizer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BinaryVectorizerextendsSerializable"></a>
<a id="BinaryVectorizer:BinaryVectorizer"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="BinaryVectorizer.html"><span class="name">BinaryVectorizer</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@BinaryVectorizerextendsSerializable" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.CategoricalNaiveBayesModel" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="CategoricalNaiveBayesModelextendsSerializablewithProduct"></a>
<a id="CategoricalNaiveBayesModel:CategoricalNaiveBayesModel"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="CategoricalNaiveBayesModel.html"><span class="name">CategoricalNaiveBayesModel</span></a><span class="params">(<span name="priors">priors: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Double" class="extype" target="_top">Double</a>]</span>, <span name="likelihoods">likelihoods: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Array" class="extype" target="_top">Array</a>[<span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Double" class="extype" target="_top">Double</a>]]]</span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@CategoricalNaiveBayesModelextendsSerializablewithProduct" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Model for naive Bayes classifiers with categorical variables.</p><div class="fullcomment"><div class="comment cmt"><p>Model for naive Bayes classifiers with categorical variables.
</p></div><dl class="paramcmts block"><dt class="param">priors</dt><dd class="cmt"><p>log prior probabilities</p></dd><dt class="param">likelihoods</dt><dd class="cmt"><p>log likelihood probabilities</p></dd></dl></div>
</li><li name="org.apache.predictionio.e2.engine.LabeledPoint" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="LabeledPointextendsProductwithSerializable"></a>
<a id="LabeledPoint:LabeledPoint"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="LabeledPoint.html"><span class="name">LabeledPoint</span></a><span class="params">(<span name="label">label: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="features">features: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Array" class="extype" target="_top">Array</a>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@LabeledPointextendsProductwithSerializable" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Class that represents the features and labels of a data point.</p><div class="fullcomment"><div class="comment cmt"><p>Class that represents the features and labels of a data point.
</p></div><dl class="paramcmts block"><dt class="param">label</dt><dd class="cmt"><p>Label of this data point</p></dd><dt class="param">features</dt><dd class="cmt"><p>Features of this data point</p></dd></dl></div>
</li><li name="org.apache.predictionio.e2.engine.MarkovChainModel" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="MarkovChainModelextendsProductwithSerializable"></a>
<a id="MarkovChainModel:MarkovChainModel"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a href="MarkovChainModel.html"><span class="name">MarkovChainModel</span></a><span class="params">(<span name="transitionVectors">transitionVectors: <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a>, <span class="extype" name="org.apache.spark.mllib.linalg.SparseVector">SparseVector</span>)]</span>, <span name="n">n: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@MarkovChainModelextendsProductwithSerializable" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Markov Chain model
</p><div class="fullcomment"><div class="comment cmt"><p>Markov Chain model
</p></div><dl class="paramcmts block"><dt class="param">transitionVectors</dt><dd class="cmt"><p>transition vectors</p></dd><dt class="param">n</dt><dd class="cmt"><p>top N used to construct the model</p></dd></dl></div>
</li><li name="org.apache.predictionio.e2.engine.PythonAlgorithm" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonAlgorithmextendsP2LAlgorithm[org.apache.predictionio.controller.EmptyPreparedData,org.apache.spark.ml.PipelineModel,org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.spark.sql.Row]"></a>
<a id="PythonAlgorithm:PythonAlgorithm"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PythonAlgorithm.html"><span class="name">PythonAlgorithm</span></a><span class="result"> extends <a href="../../controller/P2LAlgorithm.html" class="extype" name="org.apache.predictionio.controller.P2LAlgorithm">P2LAlgorithm</a>[<a href="../../controller/package.html#EmptyPreparedData=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyPreparedData">EmptyPreparedData</a>, <span class="extype" name="org.apache.spark.ml.PipelineModel">PipelineModel</span>, <span class="extype" name="org.apache.predictionio.e2.engine.PythonEngine.Query">Query</span>, <span class="extype" name="org.apache.spark.sql.Row">Row</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonAlgorithmextendsP2LAlgorithm[org.apache.predictionio.controller.EmptyPreparedData,org.apache.spark.ml.PipelineModel,org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.spark.sql.Row]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.PythonDataSource" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonDataSourceextendsPDataSource[org.apache.predictionio.controller.EmptyTrainingData,org.apache.predictionio.controller.EmptyEvaluationInfo,org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.predictionio.controller.EmptyActualResult]"></a>
<a id="PythonDataSource:PythonDataSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PythonDataSource.html"><span class="name">PythonDataSource</span></a><span class="result"> extends <a href="../../controller/PDataSource.html" class="extype" name="org.apache.predictionio.controller.PDataSource">PDataSource</a>[<a href="../../controller/package.html#EmptyTrainingData=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyTrainingData">EmptyTrainingData</a>, <a href="../../controller/package.html#EmptyEvaluationInfo=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyEvaluationInfo">EmptyEvaluationInfo</a>, <span class="extype" name="org.apache.predictionio.e2.engine.PythonEngine.Query">Query</span>, <a href="../../controller/package.html#EmptyActualResult=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyActualResult">EmptyActualResult</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonDataSourceextendsPDataSource[org.apache.predictionio.controller.EmptyTrainingData,org.apache.predictionio.controller.EmptyEvaluationInfo,org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.predictionio.controller.EmptyActualResult]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.PythonPreparator" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonPreparatorextendsPPreparator[org.apache.predictionio.controller.EmptyTrainingData,org.apache.predictionio.controller.EmptyPreparedData]"></a>
<a id="PythonPreparator:PythonPreparator"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PythonPreparator.html"><span class="name">PythonPreparator</span></a><span class="result"> extends <a href="../../controller/PPreparator.html" class="extype" name="org.apache.predictionio.controller.PPreparator">PPreparator</a>[<a href="../../controller/package.html#EmptyTrainingData=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyTrainingData">EmptyTrainingData</a>, <a href="../../controller/package.html#EmptyPreparedData=org.apache.predictionio.controller.package.SerializableClass" class="extmbr" name="org.apache.predictionio.controller.EmptyPreparedData">EmptyPreparedData</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonPreparatorextendsPPreparator[org.apache.predictionio.controller.EmptyTrainingData,org.apache.predictionio.controller.EmptyPreparedData]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.PythonServing" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonServingextendsLFirstServing[org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.spark.sql.Row]"></a>
<a id="PythonServing:PythonServing"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PythonServing.html"><span class="name">PythonServing</span></a><span class="result"> extends <a href="../../controller/LFirstServing.html" class="extype" name="org.apache.predictionio.controller.LFirstServing">LFirstServing</a>[<span class="extype" name="org.apache.predictionio.e2.engine.PythonEngine.Query">Query</span>, <span class="extype" name="org.apache.spark.sql.Row">Row</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonServingextendsLFirstServing[org.apache.predictionio.e2.engine.PythonEngine.Query,org.apache.spark.sql.Row]" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="org.apache.predictionio.e2.engine.BinaryVectorizer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BinaryVectorizer"></a>
<a id="BinaryVectorizer:BinaryVectorizer"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="BinaryVectorizer$.html"><span class="name">BinaryVectorizer</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@BinaryVectorizer" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.CategoricalNaiveBayes" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="CategoricalNaiveBayes"></a>
<a id="CategoricalNaiveBayes:CategoricalNaiveBayes"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="CategoricalNaiveBayes$.html"><span class="name">CategoricalNaiveBayes</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@CategoricalNaiveBayes" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Class for training a naive Bayes model with categorical variables</p>
</li><li name="org.apache.predictionio.e2.engine.MarkovChain" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="MarkovChain"></a>
<a id="MarkovChain:MarkovChain"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="MarkovChain$.html"><span class="name">MarkovChain</span></a>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@MarkovChain" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Class for training a Markov Chain model</p>
</li><li name="org.apache.predictionio.e2.engine.PythonEngine" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonEngine"></a>
<a id="PythonEngine:PythonEngine"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="PythonEngine$.html"><span class="name">PythonEngine</span></a><span class="result"> extends <a href="../../controller/EngineFactory.html" class="extype" name="org.apache.predictionio.controller.EngineFactory">EngineFactory</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonEngine" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="org.apache.predictionio.e2.engine.PythonServing" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PythonServing"></a>
<a id="PythonServing:PythonServing"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="PythonServing$.html"><span class="name">PythonServing</span></a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
</span>
</h4><span class="permalink">
<a href="../../../../../index.html#org.apache.predictionio.e2.engine.package@PythonServing" title="Permalink" target="_top">
<img src="../../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>