You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@predictionio.apache.org by gi...@apache.org on 2017/05/18 04:43:42 UTC
[04/51] [abbrv] [partial] incubator-predictionio-site git commit:
Documentation based on
apache/incubator-predictionio#490dd9e9fc8a055c0dd256880c164c8de21fc2fd
http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/f0ff7d76/api/current/org/apache/predictionio/core/BaseDataSource.html
----------------------------------------------------------------------
diff --git a/api/current/org/apache/predictionio/core/BaseDataSource.html b/api/current/org/apache/predictionio/core/BaseDataSource.html
new file mode 100644
index 0000000..1d7da06
--- /dev/null
+++ b/api/current/org/apache/predictionio/core/BaseDataSource.html
@@ -0,0 +1,499 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html>
+ <head>
+ <title>BaseDataSource - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.BaseDataSource</title>
+ <meta name="description" content="BaseDataSource - PredictionIO Scala API 0.11.0 - incubating - org.apache.predictionio.core.BaseDataSource" />
+ <meta name="keywords" content="BaseDataSource PredictionIO Scala API 0.11.0 incubating org.apache.predictionio.core.BaseDataSource" />
+ <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">
+ if(top === self) {
+ var url = '../../../../index.html';
+ var hash = 'org.apache.predictionio.core.BaseDataSource';
+ 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="type">
+ <div id="definition">
+ <img src="../../../../lib/class_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.core">core</a></p>
+ <h1>BaseDataSource</h1>
+ </div>
+
+ <h4 id="signature" class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">class</span>
+ </span>
+ <span class="symbol">
+ <span class="name">BaseDataSource</span><span class="tparams">[<span name="TD">TD</span>, <span name="EI">EI</span>, <span name="Q">Q</span>, <span name="A">A</span>]</span><span class="result"> extends <a href="AbstractDoer.html" class="extype" name="org.apache.predictionio.core.AbstractDoer">AbstractDoer</a></span>
+ </span>
+ </h4>
+
+ <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>:: DeveloperApi ::
+Base class of all data source controllers
+</p></div><dl class="paramcmts block"><dt class="tparam">TD</dt><dd class="cmt"><p>Training data class</p></dd><dt class="tparam">EI</dt><dd class="cmt"><p>Evaluation information class</p></dd><dt class="tparam">Q</dt><dd class="cmt"><p>Query class</p></dd><dt class="tparam">A</dt><dd class="cmt"><p>Actual result class
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl><div class="toggleContainer block">
+ <span class="toggle">Linear Supertypes</span>
+ <div class="superTypes hiddenContent"><a href="AbstractDoer.html" class="extype" name="org.apache.predictionio.core.AbstractDoer">AbstractDoer</a>, <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Serializable" class="extype" target="_top">Serializable</a>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
+ </div><div class="toggleContainer block">
+ <span class="toggle">Known Subclasses</span>
+ <div class="subClasses hiddenContent"><a href="../controller/LDataSource.html" class="extype" name="org.apache.predictionio.controller.LDataSource">LDataSource</a>, <a href="../controller/PDataSource.html" class="extype" name="org.apache.predictionio.controller.PDataSource">PDataSource</a></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.core.BaseDataSource"><span>BaseDataSource</span></li><li class="in" name="org.apache.predictionio.core.AbstractDoer"><span>AbstractDoer</span></li><li class="in" name="scala.Serializable"><span>Serializable</span></li><li class="in" name="java.io.Serializable"><span>Serializable</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>
+ <a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
+ </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="constructors" class="members">
+ <h3>Instance Constructors</h3>
+ <ol><li name="org.apache.predictionio.core.BaseDataSource#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
+ <a id="<init>():org.apache.predictionio.core.BaseDataSource[TD,EI,Q,A]"></a>
+ <a id="<init>:BaseDataSource[TD,EI,Q,A]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">new</span>
+ </span>
+ <span class="symbol">
+ <span class="name">BaseDataSource</span><span class="params">()</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt"></p>
+ </li></ol>
+ </div>
+
+
+
+ <div id="values" class="values members">
+ <h3>Abstract Value Members</h3>
+ <ol><li name="org.apache.predictionio.core.BaseDataSource#readEvalBase" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
+ <a id="readEvalBase(sc:org.apache.spark.SparkContext):Seq[(TD,EI,org.apache.spark.rdd.RDD[(Q,A)])]"></a>
+ <a id="readEvalBase(SparkContext):Seq[(TD,EI,RDD[(Q,A)])]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">readEvalBase</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>)</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[(<span class="extype" name="org.apache.predictionio.core.BaseDataSource.TD">TD</span>, <span class="extype" name="org.apache.predictionio.core.BaseDataSource.EI">EI</span>, <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<span class="extype" name="org.apache.predictionio.core.BaseDataSource.Q">Q</span>, <span class="extype" name="org.apache.predictionio.core.BaseDataSource.A">A</span>)])]</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Engine developer should not use this directly.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Engine developer should not use this directly. This is called by
+evaluation workflow to read training and validation data.
+</p></div><dl class="paramcmts block"><dt class="param">sc</dt><dd class="cmt"><p>Spark context</p></dd><dt>returns</dt><dd class="cmt"><p>Sets of training data, evaluation information, queries, and actual
+ results
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li name="org.apache.predictionio.core.BaseDataSource#readTrainingBase" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
+ <a id="readTrainingBase(sc:org.apache.spark.SparkContext):TD"></a>
+ <a id="readTrainingBase(SparkContext):TD"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">readTrainingBase</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.core.BaseDataSource.TD">TD</span></span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Engine developer should not use this directly.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Engine developer should not use this directly. This is called by workflow
+to read training data.
+</p></div><dl class="paramcmts block"><dt class="param">sc</dt><dd class="cmt"><p>Spark context</p></dd><dt>returns</dt><dd class="cmt"><p>Training data
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+ <div id="values" class="values members">
+ <h3>Concrete Value Members</h3>
+ <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="!=(x$1:AnyRef):Boolean"></a>
+ <a id="!=(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.Any#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="!=(x$1:Any):Boolean"></a>
+ <a id="!=(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="##():Int"></a>
+ <a id="##():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="==(x$1:AnyRef):Boolean"></a>
+ <a id="==(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.Any#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="==(x$1:Any):Boolean"></a>
+ <a id="==(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="asInstanceOf[T0]:T0"></a>
+ <a id="asInstanceOf[T0]:T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="clone():Object"></a>
+ <a id="clone():AnyRef"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="eq(x$1:AnyRef):Boolean"></a>
+ <a id="eq(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="equals(x$1:Any):Boolean"></a>
+ <a id="equals(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="finalize():Unit"></a>
+ <a id="finalize():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">finalize</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="symbol">classOf[java.lang.Throwable]</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="getClass():Class[_]"></a>
+ <a id="getClass():Class[_]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="hashCode():Int"></a>
+ <a id="hashCode():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">hashCode</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="ne(x$1:AnyRef):Boolean"></a>
+ <a id="ne(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="notify():Unit"></a>
+ <a id="notify():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notify</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="notifyAll():Unit"></a>
+ <a id="notifyAll():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="synchronized[T0](x$1:=>T0):T0"></a>
+ <a id="synchronized[T0](⇒T0):T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="toString():String"></a>
+ <a id="toString():String"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait():Unit"></a>
+ <a id="wait():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long,x$2:Int):Unit"></a>
+ <a id="wait(Long,Int):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long):Unit"></a>
+ <a id="wait(Long):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+
+
+
+ </div>
+
+ <div id="inheritedMembers">
+ <div class="parent" name="org.apache.predictionio.core.AbstractDoer">
+ <h3>Inherited from <a href="AbstractDoer.html" class="extype" name="org.apache.predictionio.core.AbstractDoer">AbstractDoer</a></h3>
+ </div><div class="parent" name="scala.Serializable">
+ <h3>Inherited from <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></h3>
+ </div><div class="parent" name="java.io.Serializable">
+ <h3>Inherited from <span class="extype" name="java.io.Serializable">Serializable</span></h3>
+ </div><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>
+ <script defer="defer" type="text/javascript" id="jquery-js" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" id="jquery-ui-js" src="../../../../lib/jquery-ui.js"></script><script defer="defer" type="text/javascript" id="tools-tooltip-js" src="../../../../lib/tools.tooltip.js"></script><script defer="defer" type="text/javascript" id="template-js" src="../../../../lib/template.js"></script>
+ </body>
+ </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/f0ff7d76/api/current/org/apache/predictionio/core/BaseEngine.html
----------------------------------------------------------------------
diff --git a/api/current/org/apache/predictionio/core/BaseEngine.html b/api/current/org/apache/predictionio/core/BaseEngine.html
new file mode 100644
index 0000000..bdf4b33
--- /dev/null
+++ b/api/current/org/apache/predictionio/core/BaseEngine.html
@@ -0,0 +1,544 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html>
+ <head>
+ <title>BaseEngine - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.BaseEngine</title>
+ <meta name="description" content="BaseEngine - PredictionIO Scala API 0.11.0 - incubating - org.apache.predictionio.core.BaseEngine" />
+ <meta name="keywords" content="BaseEngine PredictionIO Scala API 0.11.0 incubating org.apache.predictionio.core.BaseEngine" />
+ <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">
+ if(top === self) {
+ var url = '../../../../index.html';
+ var hash = 'org.apache.predictionio.core.BaseEngine';
+ 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="type">
+ <div id="definition">
+ <img src="../../../../lib/class_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.core">core</a></p>
+ <h1>BaseEngine</h1>
+ </div>
+
+ <h4 id="signature" class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">class</span>
+ </span>
+ <span class="symbol">
+ <span class="name">BaseEngine</span><span class="tparams">[<span name="EI">EI</span>, <span name="Q">Q</span>, <span name="P">P</span>, <span name="A">A</span>]</span><span class="result"> extends <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
+ </span>
+ </h4>
+
+ <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>:: DeveloperApi ::
+Base class of all engine controller classes
+</p></div><dl class="paramcmts block"><dt class="tparam">EI</dt><dd class="cmt"><p>Evaluation information class</p></dd><dt class="tparam">Q</dt><dd class="cmt"><p>Query class</p></dd><dt class="tparam">P</dt><dd class="cmt"><p>Predicted result class</p></dd><dt class="tparam">A</dt><dd class="cmt"><p>Actual result class
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl><div class="toggleContainer block">
+ <span class="toggle">Linear Supertypes</span>
+ <div class="superTypes hiddenContent"><a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Serializable" class="extype" target="_top">Serializable</a>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
+ </div><div class="toggleContainer block">
+ <span class="toggle">Known Subclasses</span>
+ <div class="subClasses hiddenContent"><a href="../controller/Engine.html" class="extype" name="org.apache.predictionio.controller.Engine">Engine</a>, <a href="../controller/FastEvalEngine.html" class="extype" name="org.apache.predictionio.controller.FastEvalEngine">FastEvalEngine</a>, <a href="../controller/SimpleEngine.html" class="extype" name="org.apache.predictionio.controller.SimpleEngine">SimpleEngine</a></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.core.BaseEngine"><span>BaseEngine</span></li><li class="in" name="scala.Serializable"><span>Serializable</span></li><li class="in" name="java.io.Serializable"><span>Serializable</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>
+ <a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
+ </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="constructors" class="members">
+ <h3>Instance Constructors</h3>
+ <ol><li name="org.apache.predictionio.core.BaseEngine#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
+ <a id="<init>():org.apache.predictionio.core.BaseEngine[EI,Q,P,A]"></a>
+ <a id="<init>:BaseEngine[EI,Q,P,A]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">new</span>
+ </span>
+ <span class="symbol">
+ <span class="name">BaseEngine</span><span class="params">()</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt"></p>
+ </li></ol>
+ </div>
+
+
+
+ <div id="values" class="values members">
+ <h3>Abstract Value Members</h3>
+ <ol><li name="org.apache.predictionio.core.BaseEngine#eval" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
+ <a id="eval(sc:org.apache.spark.SparkContext,engineParams:org.apache.predictionio.controller.EngineParams,params:org.apache.predictionio.workflow.WorkflowParams):Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]"></a>
+ <a id="eval(SparkContext,EngineParams,WorkflowParams):Seq[(EI,RDD[(Q,P,A)])]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">eval</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>, <span name="engineParams">engineParams: <a href="../controller/EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span>, <span name="params">params: <a href="../workflow/WorkflowParams.html" class="extype" name="org.apache.predictionio.workflow.WorkflowParams">WorkflowParams</a></span>)</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[(<span class="extype" name="org.apache.predictionio.core.BaseEngine.EI">EI</span>, <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<span class="extype" name="org.apache.predictionio.core.BaseEngine.Q">Q</span>, <span class="extype" name="org.apache.predictionio.core.BaseEngine.P">P</span>, <span class="extype" name="org.apache.predictionio.core.BaseEngine.A">A</span>)])]</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Implement this method so that <a href="../controller/Evaluation.html" class="extype" name="org.apache.predictionio.controller.Evaluation">org.apache.predictionio.controller.Evaluation</a> can
+use this method to generate inputs for <a href="../controller/Metric.html" class="extype" name="org.apache.predictionio.controller.Metric">org.apache.predictionio.controller.Metric</a>.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Implement this method so that <a href="../controller/Evaluation.html" class="extype" name="org.apache.predictionio.controller.Evaluation">org.apache.predictionio.controller.Evaluation</a> can
+use this method to generate inputs for <a href="../controller/Metric.html" class="extype" name="org.apache.predictionio.controller.Metric">org.apache.predictionio.controller.Metric</a>.
+</p></div><dl class="paramcmts block"><dt class="param">sc</dt><dd class="cmt"><p>An instance of SparkContext.</p></dd><dt class="param">engineParams</dt><dd class="cmt"><p>An instance of <span class="extype" name="EngineParams">EngineParams</span> for running a single evaluation.</p></dd><dt class="param">params</dt><dd class="cmt"><p>An instance of <span class="extype" name="WorkflowParams">WorkflowParams</span> that controls the workflow.</p></dd><dt>returns</dt><dd class="cmt"><p>A list of evaluation information and RDD of query, predicted
+ result, and actual result tuple tuple.
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li name="org.apache.predictionio.core.BaseEngine#train" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped">
+ <a id="train(sc:org.apache.spark.SparkContext,engineParams:org.apache.predictionio.controller.EngineParams,engineInstanceId:String,params:org.apache.predictionio.workflow.WorkflowParams):Seq[Any]"></a>
+ <a id="train(SparkContext,EngineParams,String,WorkflowParams):Seq[Any]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">abstract </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">train</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>, <span name="engineParams">engineParams: <a href="../controller/EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span>, <span name="engineInstanceId">engineInstanceId: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="params">params: <a href="../workflow/WorkflowParams.html" class="extype" name="org.apache.predictionio.workflow.WorkflowParams">WorkflowParams</a></span>)</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Any">Any</span>]</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Implement this method so that training this engine would return a list of
+models.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Implement this method so that training this engine would return a list of
+models.
+</p></div><dl class="paramcmts block"><dt class="param">sc</dt><dd class="cmt"><p>An instance of SparkContext.</p></dd><dt class="param">engineParams</dt><dd class="cmt"><p>An instance of <span class="extype" name="EngineParams">EngineParams</span> for running a single training.</p></dd><dt class="param">params</dt><dd class="cmt"><p>An instance of <span class="extype" name="WorkflowParams">WorkflowParams</span> that controls the workflow.</p></dd><dt>returns</dt><dd class="cmt"><p>A list of models.
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+ <div id="values" class="values members">
+ <h3>Concrete Value Members</h3>
+ <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="!=(x$1:AnyRef):Boolean"></a>
+ <a id="!=(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.Any#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="!=(x$1:Any):Boolean"></a>
+ <a id="!=(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="##():Int"></a>
+ <a id="##():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="==(x$1:AnyRef):Boolean"></a>
+ <a id="==(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.Any#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="==(x$1:Any):Boolean"></a>
+ <a id="==(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="asInstanceOf[T0]:T0"></a>
+ <a id="asInstanceOf[T0]:T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="org.apache.predictionio.core.BaseEngine#batchEval" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="batchEval(sc:org.apache.spark.SparkContext,engineParamsList:Seq[org.apache.predictionio.controller.EngineParams],params:org.apache.predictionio.workflow.WorkflowParams):Seq[(org.apache.predictionio.controller.EngineParams,Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])])]"></a>
+ <a id="batchEval(SparkContext,Seq[EngineParams],WorkflowParams):Seq[(EngineParams,Seq[(EI,RDD[(Q,P,A)])])]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">batchEval</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>, <span name="engineParamsList">engineParamsList: <span class="extype" name="scala.Seq">Seq</span>[<a href="../controller/EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a>]</span>, <span name="params">params: <a href="../workflow/WorkflowParams.html" class="extype" name="org.apache.predictionio.workflow.WorkflowParams">WorkflowParams</a></span>)</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[(<a href="../controller/EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a>, <span class="extype" name="scala.Seq">Seq</span>[(<span class="extype" name="org.apache.predictionio.core.BaseEngine.EI">EI</span>, <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[(<span class="extyp
e" name="org.apache.predictionio.core.BaseEngine.Q">Q</span>, <span class="extype" name="org.apache.predictionio.core.BaseEngine.P">P</span>, <span class="extype" name="org.apache.predictionio.core.BaseEngine.A">A</span>)])])]</span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Override this method to further optimize the process that runs multiple
+evaluations (during tuning, for example).</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Override this method to further optimize the process that runs multiple
+evaluations (during tuning, for example). By default, this method calls
+<a href="#eval(sc:org.apache.spark.SparkContext,engineParams:org.apache.predictionio.controller.EngineParams,params:org.apache.predictionio.workflow.WorkflowParams):Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]" class="extmbr" name="org.apache.predictionio.core.BaseEngine#eval">eval</a> for each element in the engine parameters list.
+</p></div><dl class="paramcmts block"><dt class="param">sc</dt><dd class="cmt"><p>An instance of SparkContext.</p></dd><dt class="param">engineParamsList</dt><dd class="cmt"><p>A list of <span class="extype" name="EngineParams">EngineParams</span> for running batch evaluation.</p></dd><dt class="param">params</dt><dd class="cmt"><p>An instance of <span class="extype" name="WorkflowParams">WorkflowParams</span> that controls the workflow.</p></dd><dt>returns</dt><dd class="cmt"><p>A list of engine parameters and evaluation result (from <a href="#eval(sc:org.apache.spark.SparkContext,engineParams:org.apache.predictionio.controller.EngineParams,params:org.apache.predictionio.workflow.WorkflowParams):Seq[(EI,org.apache.spark.rdd.RDD[(Q,P,A)])]" class="extmbr" name="org.apache.predictionio.core.BaseEngine#eval">eval</a>) tuples.
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="clone():Object"></a>
+ <a id="clone():AnyRef"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="eq(x$1:AnyRef):Boolean"></a>
+ <a id="eq(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="equals(x$1:Any):Boolean"></a>
+ <a id="equals(Any):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="finalize():Unit"></a>
+ <a id="finalize():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">finalize</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="symbol">classOf[java.lang.Throwable]</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="getClass():Class[_]"></a>
+ <a id="getClass():Class[_]"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="hashCode():Int"></a>
+ <a id="hashCode():Int"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">hashCode</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <a id="isInstanceOf[T0]:Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
+ </li><li name="org.apache.predictionio.core.BaseEngine#jValueToEngineParams" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="jValueToEngineParams(variantJson:org.json4s.JValue,jsonExtractor:org.apache.predictionio.workflow.JsonExtractorOption.JsonExtractorOption):org.apache.predictionio.controller.EngineParams"></a>
+ <a id="jValueToEngineParams(JValue,JsonExtractorOption):EngineParams"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">jValueToEngineParams</span><span class="params">(<span name="variantJson">variantJson: <span class="extype" name="org.json4s.JValue">JValue</span></span>, <span name="jsonExtractor">jsonExtractor: <a href="../workflow/JsonExtractorOption$.html#JsonExtractorOption=org.apache.predictionio.workflow.JsonExtractorOption.Value" class="extmbr" name="org.apache.predictionio.workflow.JsonExtractorOption.JsonExtractorOption">JsonExtractorOption</a></span>)</span><span class="result">: <a href="../controller/EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span>
+ </span>
+ </h4>
+ <p class="shortcomment cmt">:: DeveloperApi ::
+Implement this method to convert a JValue (read from an engine variant
+JSON file) to an instance of <span class="extype" name="EngineParams">EngineParams</span>.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi ::
+Implement this method to convert a JValue (read from an engine variant
+JSON file) to an instance of <span class="extype" name="EngineParams">EngineParams</span>.
+</p></div><dl class="paramcmts block"><dt class="param">variantJson</dt><dd class="cmt"><p>Content of the engine variant JSON as JValue.</p></dd><dt class="param">jsonExtractor</dt><dd class="cmt"><p>Content of the engine variant JSON as JValue.</p></dd><dt>returns</dt><dd class="cmt"><p>An instance of <span class="extype" name="EngineParams">EngineParams</span> converted from JSON.
+</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd>
+ <span class="name">@DeveloperApi</span><span class="args">()</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="ne(x$1:AnyRef):Boolean"></a>
+ <a id="ne(AnyRef):Boolean"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="notify():Unit"></a>
+ <a id="notify():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notify</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="notifyAll():Unit"></a>
+ <a id="notifyAll():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="synchronized[T0](x$1:=>T0):T0"></a>
+ <a id="synchronized[T0](⇒T0):T0"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
+ </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="toString():String"></a>
+ <a id="toString():String"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier"></span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait():Unit"></a>
+ <a id="wait():Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long,x$2:Int):Unit"></a>
+ <a id="wait(Long,Int):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
+ <a id="wait(x$1:Long):Unit"></a>
+ <a id="wait(Long):Unit"></a>
+ <h4 class="signature">
+ <span class="modifier_kind">
+ <span class="modifier">final </span>
+ <span class="kind">def</span>
+ </span>
+ <span class="symbol">
+ <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
+ </span>
+ </h4>
+ <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
+ <span class="name">@throws</span><span class="args">(<span>
+
+ <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
+ </span>)</span>
+
+ </dd></dl></div>
+ </li></ol>
+ </div>
+
+
+
+
+ </div>
+
+ <div id="inheritedMembers">
+ <div class="parent" name="scala.Serializable">
+ <h3>Inherited from <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></h3>
+ </div><div class="parent" name="java.io.Serializable">
+ <h3>Inherited from <span class="extype" name="java.io.Serializable">Serializable</span></h3>
+ </div><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>
+ <script defer="defer" type="text/javascript" id="jquery-js" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" id="jquery-ui-js" src="../../../../lib/jquery-ui.js"></script><script defer="defer" type="text/javascript" id="tools-tooltip-js" src="../../../../lib/tools.tooltip.js"></script><script defer="defer" type="text/javascript" id="template-js" src="../../../../lib/template.js"></script>
+ </body>
+ </html>
\ No newline at end of file