| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>MetricEvaluatorResult - PredictionIO Scala API 0.14.0 - org.apache.predictionio.controller.MetricEvaluatorResult</title> |
| <meta name="description" content="MetricEvaluatorResult - PredictionIO Scala API 0.14.0 - org.apache.predictionio.controller.MetricEvaluatorResult" /> |
| <meta name="keywords" content="MetricEvaluatorResult PredictionIO Scala API 0.14.0 org.apache.predictionio.controller.MetricEvaluatorResult" /> |
| <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.MetricEvaluatorResult'; |
| 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>MetricEvaluatorResult</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.MetricEvaluatorResult" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">MetricEvaluatorResult</span><span class="tparams">[<span name="R">R</span>]</span><span class="params">(<span name="bestScore">bestScore: <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>]</span>, <span name="bestEngineParams">bestEngineParams: <a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span>, <span name="bestIdx">bestIdx: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="metricHeader">metricHeader: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="otherMetricHeaders">otherMetricHeaders: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="engineParamsScores">engineParamsScores: <span class="extype" name="scala.Seq">Seq</span>[(<a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a>, <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>])]</span>, <span name="outputPath">outputPath: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result"> extends <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Contains all results of a <a href="MetricEvaluator.html" class="extype" name="org.apache.predictionio.controller.MetricEvaluator">MetricEvaluator</a> |
| </p></div><dl class="paramcmts block"><dt class="tparam">R</dt><dd class="cmt"><p>Type of the primary metric score</p></dd><dt class="param">bestScore</dt><dd class="cmt"><p>The best score among all iterations</p></dd><dt class="param">bestEngineParams</dt><dd class="cmt"><p>The set of engine parameters that yielded the best score</p></dd><dt class="param">bestIdx</dt><dd class="cmt"><p>The index of iteration that yielded the best score</p></dd><dt class="param">metricHeader</dt><dd class="cmt"><p>Brief description of the primary metric score</p></dd><dt class="param">otherMetricHeaders</dt><dd class="cmt"><p>Brief descriptions of other metric scores</p></dd><dt class="param">engineParamsScores</dt><dd class="cmt"><p>All sets of engine parameters and corresponding metric scores</p></dd><dt class="param">outputPath</dt><dd class="cmt"><p>An optional output path where scores are saved</p></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.11.12/index.html#scala.Product" class="extype" target="_top">Product</a>, <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Equals" class="extype" target="_top">Equals</a>, <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a>, <a href="http://www.scala-lang.org/api/2.11.12/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> |
| |
| |
| <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.MetricEvaluatorResult"><span>MetricEvaluatorResult</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="org.apache.predictionio.core.BaseEvaluatorResult"><span>BaseEvaluatorResult</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.MetricEvaluatorResult#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="<init>(bestScore:org.apache.predictionio.controller.MetricScores[R],bestEngineParams:org.apache.predictionio.controller.EngineParams,bestIdx:Int,metricHeader:String,otherMetricHeaders:Seq[String],engineParamsScores:Seq[(org.apache.predictionio.controller.EngineParams,org.apache.predictionio.controller.MetricScores[R])],outputPath:Option[String]):org.apache.predictionio.controller.MetricEvaluatorResult[R]"></a> |
| <a id="<init>:MetricEvaluatorResult[R]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">new</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">MetricEvaluatorResult</span><span class="params">(<span name="bestScore">bestScore: <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>]</span>, <span name="bestEngineParams">bestEngineParams: <a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span>, <span name="bestIdx">bestIdx: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="metricHeader">metricHeader: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="otherMetricHeaders">otherMetricHeaders: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="engineParamsScores">engineParamsScores: <span class="extype" name="scala.Seq">Seq</span>[(<a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a>, <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>])]</span>, <span name="outputPath">outputPath: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@<init>(bestScore:org.apache.predictionio.controller.MetricScores[R],bestEngineParams:org.apache.predictionio.controller.EngineParams,bestIdx:Int,metricHeader:String,otherMetricHeaders:Seq[String],engineParamsScores:Seq[(org.apache.predictionio.controller.EngineParams,org.apache.predictionio.controller.MetricScores[R])],outputPath:Option[String]):org.apache.predictionio.controller.MetricEvaluatorResult[R]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">bestScore</dt><dd class="cmt"><p>The best score among all iterations</p></dd><dt class="param">bestEngineParams</dt><dd class="cmt"><p>The set of engine parameters that yielded the best score</p></dd><dt class="param">bestIdx</dt><dd class="cmt"><p>The index of iteration that yielded the best score</p></dd><dt class="param">metricHeader</dt><dd class="cmt"><p>Brief description of the primary metric score</p></dd><dt class="param">otherMetricHeaders</dt><dd class="cmt"><p>Brief descriptions of other metric scores</p></dd><dt class="param">engineParamsScores</dt><dd class="cmt"><p>All sets of engine parameters and corresponding metric scores</p></dd><dt class="param">outputPath</dt><dd class="cmt"><p>An optional output path where scores are saved</p></dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>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: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@!=(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.12/index.html#scala.Int" class="extype" target="_top">Int</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@##():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: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@==(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.MetricEvaluatorResult@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="org.apache.predictionio.controller.MetricEvaluatorResult#bestEngineParams" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="bestEngineParams:org.apache.predictionio.controller.EngineParams"></a> |
| <a id="bestEngineParams:EngineParams"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">bestEngineParams</span><span class="result">: <a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@bestEngineParams:org.apache.predictionio.controller.EngineParams" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">The set of engine parameters that yielded the best score</p> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#bestIdx" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="bestIdx:Int"></a> |
| <a id="bestIdx:Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">bestIdx</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Int" class="extype" target="_top">Int</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@bestIdx:Int" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">The index of iteration that yielded the best score</p> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#bestScore" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="bestScore:org.apache.predictionio.controller.MetricScores[R]"></a> |
| <a id="bestScore:MetricScores[R]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">bestScore</span><span class="result">: <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@bestScore:org.apache.predictionio.controller.MetricScores[R]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">The best score among all iterations</p> |
| </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><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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="org.apache.predictionio.controller.MetricEvaluatorResult#engineParamsScores" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="engineParamsScores:Seq[(org.apache.predictionio.controller.EngineParams,org.apache.predictionio.controller.MetricScores[R])]"></a> |
| <a id="engineParamsScores:Seq[(EngineParams,MetricScores[R])]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">engineParamsScores</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[(<a href="EngineParams.html" class="extype" name="org.apache.predictionio.controller.EngineParams">EngineParams</a>, <a href="MetricScores.html" class="extype" name="org.apache.predictionio.controller.MetricScores">MetricScores</a>[<span class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult.R">R</span>])]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@engineParamsScores:Seq[(org.apache.predictionio.controller.EngineParams,org.apache.predictionio.controller.MetricScores[R])]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">All sets of engine parameters and corresponding metric scores</p> |
| </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.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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#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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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.MetricEvaluatorResult@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.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.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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="org.apache.predictionio.controller.MetricEvaluatorResult#metricHeader" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="metricHeader:String"></a> |
| <a id="metricHeader:String"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">metricHeader</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@metricHeader:String" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Brief description of the primary metric score</p> |
| </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.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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="org.apache.predictionio.core.BaseEvaluatorResult#noSave" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="noSave:Boolean"></a> |
| <a id="noSave:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">noSave</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@noSave:Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">:: Experimental :: |
| Indicate if this result is inserted into database |
| </p><div class="fullcomment"><div class="comment cmt"><p>:: Experimental :: |
| Indicate if this result is inserted into database |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a></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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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.MetricEvaluatorResult#otherMetricHeaders" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="otherMetricHeaders:Seq[String]"></a> |
| <a id="otherMetricHeaders:Seq[String]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">otherMetricHeaders</span><span class="result">: <span class="extype" name="scala.Seq">Seq</span>[<span class="extype" name="scala.Predef.String">String</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@otherMetricHeaders:Seq[String]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Brief descriptions of other metric scores</p> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#outputPath" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="outputPath:Option[String]"></a> |
| <a id="outputPath:Option[String]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">outputPath</span><span class="result">: <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Option" class="extype" target="_top">Option</a>[<span class="extype" name="scala.Predef.String">String</span>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@outputPath:Option[String]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">An optional output path where scores are saved</p> |
| </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.MetricEvaluatorResult@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="org.apache.predictionio.controller.MetricEvaluatorResult#toHTML" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toHTML():String"></a> |
| <a id="toHTML():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">toHTML</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@toHTML():String" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">HTML portion of the rendered evaluator results</p><div class="fullcomment"><div class="comment cmt"><p>HTML portion of the rendered evaluator results</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult">MetricEvaluatorResult</a> → <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a></dd></dl></div> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#toJSON" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toJSON():String"></a> |
| <a id="toJSON():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">toJSON</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@toJSON():String" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">JSON portion of the rendered evaluator results</p><div class="fullcomment"><div class="comment cmt"><p>JSON portion of the rendered evaluator results</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult">MetricEvaluatorResult</a> → <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a></dd></dl></div> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#toOneLiner" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toOneLiner():String"></a> |
| <a id="toOneLiner():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">toOneLiner</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@toOneLiner():String" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">A short description of the result</p><div class="fullcomment"><div class="comment cmt"><p>A short description of the result</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult">MetricEvaluatorResult</a> → <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a></dd></dl></div> |
| </li><li name="org.apache.predictionio.controller.MetricEvaluatorResult#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="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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><a href="" class="extype" name="org.apache.predictionio.controller.MetricEvaluatorResult">MetricEvaluatorResult</a> → 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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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.12/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.12/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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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.12/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.12/index.html#scala.Unit" class="extype" target="_top">Unit</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.predictionio.controller.MetricEvaluatorResult@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="scala.Product"> |
| <h3>Inherited from <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Product" class="extype" target="_top">Product</a></h3> |
| </div><div class="parent" name="scala.Equals"> |
| <h3>Inherited from <a href="http://www.scala-lang.org/api/2.11.12/index.html#scala.Equals" class="extype" target="_top">Equals</a></h3> |
| </div><div class="parent" name="org.apache.predictionio.core.BaseEvaluatorResult"> |
| <h3>Inherited from <a href="../core/BaseEvaluatorResult.html" class="extype" name="org.apache.predictionio.core.BaseEvaluatorResult">BaseEvaluatorResult</a></h3> |
| </div><div class="parent" name="scala.Serializable"> |
| <h3>Inherited from <a href="http://www.scala-lang.org/api/2.11.12/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> |
| |
| |
| </body> |
| </html> |
