http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/0927bfda/api/current/org/apache/predictionio/controller/LPreparator.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LPreparator.html b/api/current/org/apache/predictionio/controller/LPreparator.html new file mode 100644 index 0000000..7474c79 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LPreparator.html @@ -0,0 +1,556 @@ +<!DOCTYPE html > +<html> + <head> + <title>LPreparator - PredictionIO Scala API 0.12.0-incubating - org.apache.predictionio.controller.LPreparator</title> + <meta name="description" content="LPreparator - PredictionIO Scala API 0.12.0 - incubating - org.apache.predictionio.controller.LPreparator" /> + <meta name="keywords" content="LPreparator PredictionIO Scala API 0.12.0 incubating org.apache.predictionio.controller.LPreparator" /> + <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.controller.LPreparator'; + 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 alt="Class" 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.controller">controller</a></p> + <h1>LPreparator</h1><h3><span class="morelinks"><div>Related Doc: + <a href="package.html" class="extype" name="org.apache.predictionio.controller">package controller</a> + </div></span></h3><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator" 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">abstract </span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <span class="name">LPreparator</span><span class="tparams">[<span name="TD">TD</span>, <span name="PD">PD</span>]</span><span class="result"> extends <a href="../core/BasePreparator.html" class="extype" name="org.apache.predictionio.core.BasePreparator">BasePreparator</a>[<span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.TD">TD</span>], <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span>]]</span> + </span> + </h4> + + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Base class of a local preparator.</p><p>A local preparator runs locally within a single machine and produces +prepared data that can fit within a single machine. +</p></div><dl class="paramcmts block"><dt class="tparam">TD</dt><dd class="cmt"><p>Training data class.</p></dd><dt class="tparam">PD</dt><dd class="cmt"><p>Prepared data class.</p></dd></dl><div class="toggleContainer block"> + <span class="toggle">Linear Supertypes</span> + <div class="superTypes hiddenContent"><a href="../core/BasePreparator.html" class="extype" name="org.apache.predictionio.core.BasePreparator">BasePreparator</a>[<span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.TD">TD</span>], <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span>]], <a href="../core/AbstractDoer.html" class="extype" name="org.apache.predictionio.core.AbstractDoer">AbstractDoer</a>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Serializable" class="extype" target="_top">Serializable</a>, <span class="extype" name="java.io.Serializable">Serializable</span>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_t op">Any</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.controller.LPreparator"><span>LPreparator</span></li><li class="in" name="org.apache.predictionio.core.BasePreparator"><span>BasePreparator</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> + </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.controller.LPreparator#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="<init>()(implicitevidence$1:scala.reflect.ClassTag[PD]):org.apache.predictionio.controller.LPreparator[TD,PD]"></a> + <a id="<init>:LPreparator[TD,PD]"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">new</span> + </span> + <span class="symbol"> + <span class="name">LPreparator</span><span class="params">()</span><span class="params">(<span class="implicit">implicit </span><span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.reflect.ClassTag" class="extype" target="_top">ClassTag</a>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span>]</span>)</span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@<init>()(implicitevidence$1:scala.reflect.ClassTag[PD]):org.apache.predictionio.controller.LPreparator[TD,PD]" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.controller.LPreparator#prepare" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> + <a id="prepare(trainingData:TD):PD"></a> + <a id="prepare(TD):PD"></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">prepare</span><span class="params">(<span name="trainingData">trainingData: <span class="extype" name="org.apache.predictionio.controller.LPreparator.TD">TD</span></span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@prepare(trainingData:TD):PD" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">Implement this method to produce prepared data that is ready for model +training.</p><div class="fullcomment"><div class="comment cmt"><p>Implement this method to produce prepared data that is ready for model +training. +</p></div><dl class="paramcmts block"><dt class="param">trainingData</dt><dd class="cmt"><p>Training data to be prepared.</p></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: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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@!=(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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="##():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.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@##():Int" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@==(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef â 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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@asInstanceOf[T0]:T0" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@clone():Object" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@equals(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@finalize():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@getClass():Class[_]" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@hashCode():Int" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@isInstanceOf[T0]:Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@notify():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@notifyAll():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="org.apache.predictionio.controller.LPreparator#prepareBase" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="prepareBase(sc:org.apache.spark.SparkContext,rddTd:org.apache.spark.rdd.RDD[TD]):org.apache.spark.rdd.RDD[PD]"></a> + <a id="prepareBase(SparkContext,RDD[TD]):RDD[PD]"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">prepareBase</span><span class="params">(<span name="sc">sc: <span class="extype" name="org.apache.spark.SparkContext">SparkContext</span></span>, <span name="rddTd">rddTd: <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.TD">TD</span>]</span>)</span><span class="result">: <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span>]</span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@prepareBase(sc:org.apache.spark.SparkContext,rddTd:org.apache.spark.rdd.RDD[TD]):org.apache.spark.rdd.RDD[PD]" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">:: DeveloperApi :: +Engine developers should not use this directly.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: +Engine developers should not use this directly. This is called by training +workflow to prepare data before handing it over to algorithm +</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>Prepared data</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.LPreparator">LPreparator</a> â <a href="../core/BasePreparator.html" class="extype" name="org.apache.predictionio.core.BasePreparator">BasePreparator</a></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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@synchronized[T0](x$1:=>T0):T0" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@toString():String" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@wait():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LPreparator@wait(x$1:Long):Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.BasePreparator"> + <h3>Inherited from <a href="../core/BasePreparator.html" class="extype" name="org.apache.predictionio.core.BasePreparator">BasePreparator</a>[<span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.TD">TD</span>], <span class="extype" name="org.apache.spark.rdd.RDD">RDD</span>[<span class="extype" name="org.apache.predictionio.controller.LPreparator.PD">PD</span>]]</h3> + </div><div class="parent" name="org.apache.predictionio.core.AbstractDoer"> + <h3>Inherited from <a href="../core/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.11.8/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 <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></h3> + </div><div class="parent" name="scala.Any"> + <h3>Inherited from <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></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>
http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/0927bfda/api/current/org/apache/predictionio/controller/LServing.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LServing.html b/api/current/org/apache/predictionio/controller/LServing.html new file mode 100644 index 0000000..291ccd8 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LServing.html @@ -0,0 +1,606 @@ +<!DOCTYPE html > +<html> + <head> + <title>LServing - PredictionIO Scala API 0.12.0-incubating - org.apache.predictionio.controller.LServing</title> + <meta name="description" content="LServing - PredictionIO Scala API 0.12.0 - incubating - org.apache.predictionio.controller.LServing" /> + <meta name="keywords" content="LServing PredictionIO Scala API 0.12.0 incubating org.apache.predictionio.controller.LServing" /> + <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.controller.LServing'; + 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 alt="Class" 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.controller">controller</a></p> + <h1>LServing</h1><h3><span class="morelinks"><div>Related Doc: + <a href="package.html" class="extype" name="org.apache.predictionio.controller">package controller</a> + </div></span></h3><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing" 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">abstract </span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <span class="name">LServing</span><span class="tparams">[<span name="Q">Q</span>, <span name="P">P</span>]</span><span class="result"> extends <a href="../core/BaseServing.html" class="extype" name="org.apache.predictionio.core.BaseServing">BaseServing</a>[<span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span>, <span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span>]</span> + </span> + </h4> + + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Base class of serving. +</p></div><dl class="paramcmts block"><dt class="tparam">Q</dt><dd class="cmt"><p>Input query class.</p></dd><dt class="tparam">P</dt><dd class="cmt"><p>Output prediction class.</p></dd></dl><div class="toggleContainer block"> + <span class="toggle">Linear Supertypes</span> + <div class="superTypes hiddenContent"><a href="../core/BaseServing.html" class="extype" name="org.apache.predictionio.core.BaseServing">BaseServing</a>[<span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span>, <span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span>], <a href="../core/AbstractDoer.html" class="extype" name="org.apache.predictionio.core.AbstractDoer">AbstractDoer</a>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Serializable" class="extype" target="_top">Serializable</a>, <span class="extype" name="java.io.Serializable">Serializable</span>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a>, <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></div> + </div><div class="toggleContainer block"> + <span class="toggle">Known Subclasses</span> + <div class="subClasses hiddenContent"><a href="LAverageServing.html" class="extype" name="org.apache.predictionio.controller.LAverageServing">LAverageServing</a>, <a href="LFirstServing.html" class="extype" name="org.apache.predictionio.controller.LFirstServing">LFirstServing</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.controller.LServing"><span>LServing</span></li><li class="in" name="org.apache.predictionio.core.BaseServing"><span>BaseServing</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> + </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.controller.LServing#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="<init>():org.apache.predictionio.controller.LServing[Q,P]"></a> + <a id="<init>:LServing[Q,P]"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">new</span> + </span> + <span class="symbol"> + <span class="name">LServing</span><span class="params">()</span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@<init>():org.apache.predictionio.controller.LServing[Q,P]" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.controller.LServing#serve" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> + <a id="serve(query:Q,predictions:Seq[P]):P"></a> + <a id="serve(Q,Seq[P]):P"></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">serve</span><span class="params">(<span name="query">query: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span>, <span name="predictions">predictions: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span>]</span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@serve(query:Q,predictions:Seq[P]):P" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">Implement this method to combine multiple algorithms' predictions to +produce a single final prediction.</p><div class="fullcomment"><div class="comment cmt"><p>Implement this method to combine multiple algorithms' predictions to +produce a single final prediction. The query is the original query sent to +the engine, not the supplemented produced by <a href="#supplement(q:Q):Q" class="extmbr" name="org.apache.predictionio.controller.LServing#supplement">LServing.supplement</a>. +</p></div><dl class="paramcmts block"><dt class="param">query</dt><dd class="cmt"><p>Original input query.</p></dd><dt class="param">predictions</dt><dd class="cmt"><p>A list of algorithms' predictions.</p></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: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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@!=(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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="##():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.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@##():Int" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@==(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef â 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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@asInstanceOf[T0]:T0" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@clone():Object" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@equals(x$1:Any):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@finalize():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@getClass():Class[_]" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@hashCode():Int" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@isInstanceOf[T0]:Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@notify():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@notifyAll():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="org.apache.predictionio.controller.LServing#serveBase" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="serveBase(q:Q,ps:Seq[P]):P"></a> + <a id="serveBase(Q,Seq[P]):P"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">serveBase</span><span class="params">(<span name="q">q: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span>, <span name="ps">ps: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span>]</span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@serveBase(q:Q,ps:Seq[P]):P" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">:: DeveloperApi :: +Engine developers should not use this directly.</p><div class="fullcomment"><div class="comment cmt"><p>:: DeveloperApi :: +Engine developers should not use this directly. This is called by serving +layer to combine multiple predicted results from multiple algorithms, and +custom business logic before serving to the end user. +</p></div><dl class="paramcmts block"><dt class="param">q</dt><dd class="cmt"><p>Query</p></dd><dt class="param">ps</dt><dd class="cmt"><p>List of predicted results</p></dd><dt>returns</dt><dd class="cmt"><p>A single predicted result</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.LServing">LServing</a> â <a href="../core/BaseServing.html" class="extype" name="org.apache.predictionio.core.BaseServing">BaseServing</a></dd></dl></div> + </li><li name="org.apache.predictionio.controller.LServing#supplement" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="supplement(q:Q):Q"></a> + <a id="supplement(Q):Q"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">supplement</span><span class="params">(<span name="q">q: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@supplement(q:Q):Q" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">:: Experimental :: +Implement this method to supplement the query before sending it to +algorithms.</p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental :: +Implement this method to supplement the query before sending it to +algorithms. +</p></div><dl class="paramcmts block"><dt class="param">q</dt><dd class="cmt"><p>Query</p></dd><dt>returns</dt><dd class="cmt"><p>A supplemented Query</p></dd></dl><dl class="attributes block"> <dt>Annotations</dt><dd> + <span class="name">@Experimental</span><span class="args">()</span> + + </dd></dl></div> + </li><li name="org.apache.predictionio.controller.LServing#supplementBase" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="supplementBase(q:Q):Q"></a> + <a id="supplementBase(Q):Q"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">supplementBase</span><span class="params">(<span name="q">q: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span>)</span><span class="result">: <span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@supplementBase(q:Q):Q" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">:: Experimental :: +Engine developers should not use this directly.</p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental :: +Engine developers should not use this directly. This is called by serving +layer to supplement process the query before sending it to algorithms. +</p></div><dl class="paramcmts block"><dt class="param">q</dt><dd class="cmt"><p>Query</p></dd><dt>returns</dt><dd class="cmt"><p>A supplement Query</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.LServing">LServing</a> â <a href="../core/BaseServing.html" class="extype" name="org.apache.predictionio.core.BaseServing">BaseServing</a></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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@synchronized[T0](x$1:=>T0):T0" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@toString():String" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@wait():Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.11.8/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#org.apache.predictionio.controller.LServing@wait(x$1:Long):Unit" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <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.BaseServing"> + <h3>Inherited from <a href="../core/BaseServing.html" class="extype" name="org.apache.predictionio.core.BaseServing">BaseServing</a>[<span class="extype" name="org.apache.predictionio.controller.LServing.Q">Q</span>, <span class="extype" name="org.apache.predictionio.controller.LServing.P">P</span>]</h3> + </div><div class="parent" name="org.apache.predictionio.core.AbstractDoer"> + <h3>Inherited from <a href="../core/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.11.8/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 <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.AnyRef" class="extype" target="_top">AnyRef</a></h3> + </div><div class="parent" name="scala.Any"> + <h3>Inherited from <a href="http://www.scala-lang.org/api/2.11.8/index.html#scala.Any" class="extype" target="_top">Any</a></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>