| <!DOCTYPE html > |
| <html> |
| <head> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" /> |
| <title>Spark 3.4.3 ScalaDoc - org.apache.spark.mllib.optimization.HingeGradient</title> |
| <meta name="description" content="Spark 3.4.3 ScalaDoc - org.apache.spark.mllib.optimization.HingeGradient" /> |
| <meta name="keywords" content="Spark 3.4.3 ScalaDoc org.apache.spark.mllib.optimization.HingeGradient" /> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| |
| |
| <link href="../../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet" /> |
| <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.min.js"></script> |
| <script type="text/javascript" src="../../../../../lib/jquery.panzoom.min.js"></script> |
| <script type="text/javascript" src="../../../../../lib/jquery.mousewheel.min.js"></script> |
| <script type="text/javascript" src="../../../../../lib/index.js"></script> |
| <script type="text/javascript" src="../../../../../index.js"></script> |
| <script type="text/javascript" src="../../../../../lib/scheduler.js"></script> |
| <script type="text/javascript" src="../../../../../lib/template.js"></script> |
| |
| <script type="text/javascript"> |
| /* this variable can be used by the JS to determine the path to the root document */ |
| var toRoot = '../../../../../'; |
| </script> |
| |
| </head> |
| <body> |
| <div id="search"> |
| <span id="doc-title">Spark 3.4.3 ScalaDoc<span id="doc-version"></span></span> |
| <span class="close-results"><span class="left"><</span> Back</span> |
| <div id="textfilter"> |
| <span class="input"> |
| <input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/" /> |
| <i class="clear material-icons"></i> |
| <i id="search-icon" class="material-icons"></i> |
| </span> |
| </div> |
| </div> |
| <div id="search-results"> |
| <div id="search-progress"> |
| <div id="progress-fill"></div> |
| </div> |
| <div id="results-content"> |
| <div id="entity-results"></div> |
| <div id="member-results"></div> |
| </div> |
| </div> |
| <div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"> |
| <div id="content-container" style="-webkit-overflow-scrolling: touch;"> |
| <div id="subpackage-spacer"> |
| <div id="packages"> |
| <h1>Packages</h1> |
| <ul> |
| <li name="_root_.root" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="_root_"></a><a id="root:_root_"></a> |
| <span class="permalink"> |
| <a href="../../../../../index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="" href="../../../../../index.html"><span class="name">root</span></a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../../index.html" class="extype" name="_root_">root</a></dd></dl></div> |
| </li><li name="_root_.org" visbl="pub" class="indented1 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="org"></a><a id="org:org"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="" href="../../../../index.html"><span class="name">org</span></a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../../index.html" class="extype" name="_root_">root</a></dd></dl></div> |
| </li><li name="org.apache" visbl="pub" class="indented2 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="apache"></a><a id="apache:apache"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="" href="../../../index.html"><span class="name">apache</span></a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../../index.html" class="extype" name="org">org</a></dd></dl></div> |
| </li><li name="org.apache.spark" visbl="pub" class="indented3 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="spark"></a><a id="spark:spark"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="Core Spark functionality." href="../../index.html"><span class="name">spark</span></a> |
| </span> |
| |
| <p class="shortcomment cmt">Core Spark functionality.</p><div class="fullcomment"><div class="comment cmt"><p>Core Spark functionality. <a href="../../SparkContext.html" class="extype" name="org.apache.spark.SparkContext">org.apache.spark.SparkContext</a> serves as the main entry point to |
| Spark, while <a href="../../rdd/RDD.html" class="extype" name="org.apache.spark.rdd.RDD">org.apache.spark.rdd.RDD</a> is the data type representing a distributed collection, |
| and provides most parallel operations.</p><p>In addition, <a href="../../rdd/PairRDDFunctions.html" class="extype" name="org.apache.spark.rdd.PairRDDFunctions">org.apache.spark.rdd.PairRDDFunctions</a> contains operations available only on RDDs |
| of key-value pairs, such as <code>groupByKey</code> and <code>join</code>; <a href="../../rdd/DoubleRDDFunctions.html" class="extype" name="org.apache.spark.rdd.DoubleRDDFunctions">org.apache.spark.rdd.DoubleRDDFunctions</a> |
| contains operations available only on RDDs of Doubles; and |
| <a href="../../rdd/SequenceFileRDDFunctions.html" class="extype" name="org.apache.spark.rdd.SequenceFileRDDFunctions">org.apache.spark.rdd.SequenceFileRDDFunctions</a> contains operations available on RDDs that can |
| be saved as SequenceFiles. These operations are automatically available on any RDD of the right |
| type (e.g. RDD[(Int, Int)] through implicit conversions.</p><p>Java programmers should reference the <a href="../../api/java/index.html" class="extype" name="org.apache.spark.api.java">org.apache.spark.api.java</a> package |
| for Spark programming APIs in Java.</p><p>Classes and methods marked with <span class="experimental badge" style="float: none;"> |
| Experimental</span> are user-facing features which have not been officially adopted by the |
| Spark project. These are subject to change or removal in minor releases.</p><p>Classes and methods marked with <span class="developer badge" style="float: none;"> |
| Developer API</span> are intended for advanced users want to extend Spark through lower |
| level interfaces. These are subject to changes or removal in minor releases. |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../../index.html" class="extype" name="org.apache">apache</a></dd></dl></div> |
| </li><li name="org.apache.spark.mllib" visbl="pub" class="indented4 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="mllib"></a><a id="mllib:mllib"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="RDD-based machine learning APIs (in maintenance mode)." href="../index.html"><span class="name">mllib</span></a> |
| </span> |
| |
| <p class="shortcomment cmt">RDD-based machine learning APIs (in maintenance mode).</p><div class="fullcomment"><div class="comment cmt"><p>RDD-based machine learning APIs (in maintenance mode).</p><p>The <code>spark.mllib</code> package is in maintenance mode as of the Spark 2.0.0 release to encourage |
| migration to the DataFrame-based APIs under the <a href="../../ml/index.html" class="extype" name="org.apache.spark.ml">org.apache.spark.ml</a> package. |
| While in maintenance mode,</p><ul><li>no new features in the RDD-based <code>spark.mllib</code> package will be accepted, unless they block |
| implementing new features in the DataFrame-based <code>spark.ml</code> package;</li><li>bug fixes in the RDD-based APIs will still be accepted.</li></ul><p>The developers will continue adding more features to the DataFrame-based APIs in the 2.x series |
| to reach feature parity with the RDD-based APIs. |
| And once we reach feature parity, this package will be deprecated. |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../index.html" class="extype" name="org.apache.spark">spark</a></dd><dt>See also</dt><dd><span class="cmt"><p><a href="https://issues.apache.org/jira/browse/SPARK-4591">SPARK-4591</a> to track |
| the progress of feature parity</p></span></dd></dl></div> |
| </li><li name="org.apache.spark.mllib.optimization" visbl="pub" class="indented5 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="optimization"></a><a id="optimization:optimization"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/index.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a title="" href="index.html"><span class="name">optimization</span></a> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../index.html" class="extype" name="org.apache.spark.mllib">mllib</a></dd></dl></div> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="Gradient.html" title="Class used to compute the gradient for a loss function, given a single data point."></a> |
| <a href="Gradient.html" title="Class used to compute the gradient for a loss function, given a single data point.">Gradient</a> |
| </li><li class="current-entities indented5"> |
| <a class="object" href="GradientDescent$.html" title="Top-level method to run gradient descent."></a> |
| <a class="class" href="GradientDescent.html" title="Class used to solve an optimization problem using Gradient Descent."></a> |
| <a href="GradientDescent.html" title="Class used to solve an optimization problem using Gradient Descent.">GradientDescent</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="" title="Compute gradient and loss for a Hinge loss function, as used in SVM binary classification."></a> |
| <a href="" title="Compute gradient and loss for a Hinge loss function, as used in SVM binary classification.">HingeGradient</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="L1Updater.html" title="Updater for L1 regularized problems."></a> |
| <a href="L1Updater.html" title="Updater for L1 regularized problems.">L1Updater</a> |
| </li><li class="current-entities indented5"> |
| <a class="object" href="LBFGS$.html" title="Top-level method to run L-BFGS."></a> |
| <a class="class" href="LBFGS.html" title="Class used to solve an optimization problem using Limited-memory BFGS."></a> |
| <a href="LBFGS.html" title="Class used to solve an optimization problem using Limited-memory BFGS.">LBFGS</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="LeastSquaresGradient.html" title="Compute gradient and loss for a Least-squared loss function, as used in linear regression."></a> |
| <a href="LeastSquaresGradient.html" title="Compute gradient and loss for a Least-squared loss function, as used in linear regression.">LeastSquaresGradient</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="LogisticGradient.html" title="Compute gradient and loss for a multinomial logistic loss function, as used in multi-class classification (it is also used in binary logistic regression)."></a> |
| <a href="LogisticGradient.html" title="Compute gradient and loss for a multinomial logistic loss function, as used in multi-class classification (it is also used in binary logistic regression).">LogisticGradient</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="trait" href="Optimizer.html" title="Trait for optimization problem solvers."></a> |
| <a href="Optimizer.html" title="Trait for optimization problem solvers.">Optimizer</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="SimpleUpdater.html" title="A simple updater for gradient descent *without* any regularization."></a> |
| <a href="SimpleUpdater.html" title="A simple updater for gradient descent *without* any regularization.">SimpleUpdater</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="SquaredL2Updater.html" title="Updater for L2 regularized problems."></a> |
| <a href="SquaredL2Updater.html" title="Updater for L2 regularized problems.">SquaredL2Updater</a> |
| </li><li class="current-entities indented5"> |
| <span class="separator"></span> |
| <a class="class" href="Updater.html" title="Class used to perform steps (weight update) using Gradient Descent methods."></a> |
| <a href="Updater.html" title="Class used to perform steps (weight update) using Gradient Descent methods.">Updater</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div id="content"> |
| <body class="class type"> |
| <div id="definition"> |
| <div class="big-circle class">c</div> |
| <p id="owner"><a href="../../../../index.html" class="extype" name="org">org</a>.<a href="../../../index.html" class="extype" name="org.apache">apache</a>.<a href="../../index.html" class="extype" name="org.apache.spark">spark</a>.<a href="../index.html" class="extype" name="org.apache.spark.mllib">mllib</a>.<a href="index.html" class="extype" name="org.apache.spark.mllib.optimization">optimization</a></p> |
| <h1>HingeGradient<span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span></h1> |
| <h3><span class="morelinks"></span></h3> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">HingeGradient</span><span class="result"> extends <a href="Gradient.html" class="extype" name="org.apache.spark.mllib.optimization.Gradient">Gradient</a></span> |
| </span> |
| </h4> |
| |
| |
| <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Compute gradient and loss for a Hinge loss function, as used in SVM binary classification. |
| See also the documentation for the precise formulation. |
| </p></div><dl class="attributes block"> <dt>Source</dt><dd><a href="https://github.com/apache/spark/tree/v3.4.3/mllib/src/main/scala/org/apache/spark/mllib/optimization/Gradient.scala" target="_blank">Gradient.scala</a></dd><dt>Note</dt><dd><span class="cmt"><p>This assumes that the labels are {0,1}</p></span></dd></dl><div class="toggleContainer block"> |
| <span class="toggle"> |
| Linear Supertypes |
| </span> |
| <div class="superTypes hiddenContent"><a href="Gradient.html" class="extype" name="org.apache.spark.mllib.optimization.Gradient">Gradient</a>, <span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <a href="../../../../../scala/index.html#AnyRef=Object" class="extmbr" name="scala.AnyRef">AnyRef</a>, <span class="extype" name="scala.Any">Any</span></div> |
| </div></div> |
| |
| |
| <div id="mbrsel"> |
| <div class="toggle"></div> |
| <div id="memberfilter"> |
| <i class="material-icons arrow"></i> |
| <span class="input"> |
| <input id="mbrsel-input" placeholder="Filter all members" type="text" accesskey="/" /> |
| </span> |
| <i class="clear material-icons"></i> |
| </div> |
| <div id="filterby"> |
| <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 class="ancestors"> |
| <span class="filtertype">Inherited<br /> |
| </span> |
| <ol id="linearization"> |
| <li class="in" name="org.apache.spark.mllib.optimization.HingeGradient"><span>HingeGradient</span></li><li class="in" name="org.apache.spark.mllib.optimization.Gradient"><span>Gradient</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 class="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> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| <div id="constructors" class="members"> |
| <h3>Instance Constructors</h3> |
| <ol><li name="org.apache.spark.mllib.optimization.HingeGradient#<init>" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="<init>():org.apache.spark.mllib.optimization.HingeGradient"></a><a id="<init>:HingeGradient"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#<init>():org.apache.spark.mllib.optimization.HingeGradient" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">new</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">HingeGradient</span><span class="params">()</span> |
| </span> |
| |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| |
| <div class="values members"> |
| <h3>Value Members</h3> |
| <ol> |
| <li name="scala.AnyRef#!=" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#!=(x$1:Any):Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="##():Int"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html###():Int" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Int">Int</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#==(x$1:Any):Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#asInstanceOf[T0]:T0" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="scala.AnyRef#clone" visbl="prt" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="clone():Object"></a><a id="clone():AnyRef"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#clone():Object" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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="../../../../../scala/index.html#AnyRef=Object" class="extmbr" name="scala.AnyRef">AnyRef</a></span> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<span class="extype" name="java.lang">lang</span>] </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> |
| |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.spark.mllib.optimization.HingeGradient#compute" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="compute(data:org.apache.spark.mllib.linalg.Vector,label:Double,weights:org.apache.spark.mllib.linalg.Vector,cumGradient:org.apache.spark.mllib.linalg.Vector):Double"></a><a id="compute(Vector,Double,Vector,Vector):Double"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#compute(data:org.apache.spark.mllib.linalg.Vector,label:Double,weights:org.apache.spark.mllib.linalg.Vector,cumGradient:org.apache.spark.mllib.linalg.Vector):Double" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">compute</span><span class="params">(<span name="data">data: <a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a></span>, <span name="label">label: <span class="extype" name="scala.Double">Double</span></span>, <span name="weights">weights: <a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a></span>, <span name="cumGradient">cumGradient: <a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a></span>)</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span> |
| </span> |
| |
| <p class="shortcomment cmt">Compute the gradient and loss given the features of a single data point, |
| add the gradient to a provided vector to avoid creating new objects, and return loss.</p><div class="fullcomment"><div class="comment cmt"><p>Compute the gradient and loss given the features of a single data point, |
| add the gradient to a provided vector to avoid creating new objects, and return loss. |
| </p></div><dl class="paramcmts block"><dt class="param">data</dt><dd class="cmt"><p>features for one data point</p></dd><dt class="param">label</dt><dd class="cmt"><p>label for this data point</p></dd><dt class="param">weights</dt><dd class="cmt"><p>weights/coefficients corresponding to features</p></dd><dt class="param">cumGradient</dt><dd class="cmt"><p>the computed gradient will be added to this vector</p></dd><dt>returns</dt><dd class="cmt"><p>loss</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.spark.mllib.optimization.HingeGradient">HingeGradient</a> → <a href="Gradient.html" class="extype" name="org.apache.spark.mllib.optimization.Gradient">Gradient</a></dd></dl></div> |
| </li><li name="org.apache.spark.mllib.optimization.HingeGradient#compute" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="compute(data:org.apache.spark.mllib.linalg.Vector,label:Double,weights:org.apache.spark.mllib.linalg.Vector):(org.apache.spark.mllib.linalg.Vector,Double)"></a><a id="compute(Vector,Double,Vector):(Vector,Double)"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#compute(data:org.apache.spark.mllib.linalg.Vector,label:Double,weights:org.apache.spark.mllib.linalg.Vector):(org.apache.spark.mllib.linalg.Vector,Double)" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">compute</span><span class="params">(<span name="data">data: <a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a></span>, <span name="label">label: <span class="extype" name="scala.Double">Double</span></span>, <span name="weights">weights: <a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a></span>)</span><span class="result">: (<a href="../linalg/Vector.html" class="extype" name="org.apache.spark.mllib.linalg.Vector">Vector</a>, <span class="extype" name="scala.Double">Double</span>)</span> |
| </span> |
| |
| <p class="shortcomment cmt">Compute the gradient and loss given the features of a single data point.</p><div class="fullcomment"><div class="comment cmt"><p>Compute the gradient and loss given the features of a single data point. |
| </p></div><dl class="paramcmts block"><dt class="param">data</dt><dd class="cmt"><p>features for one data point</p></dd><dt class="param">label</dt><dd class="cmt"><p>label for this data point</p></dd><dt class="param">weights</dt><dd class="cmt"><p>weights/coefficients corresponding to features</p></dd><dt>returns</dt><dd class="cmt"><p>(gradient: Vector, loss: Double)</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.spark.mllib.optimization.HingeGradient">HingeGradient</a> → <a href="Gradient.html" class="extype" name="org.apache.spark.mllib.optimization.Gradient">Gradient</a></dd></dl></div> |
| </li><li name="scala.AnyRef#eq" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#eq(x$1:AnyRef):Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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="../../../../../scala/index.html#AnyRef=Object" class="extmbr" name="scala.AnyRef">AnyRef</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="equals(x$1:Any):Boolean"></a><a id="equals(Any):Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#equals(x$1:Any):Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="finalize():Unit"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#finalize():Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<span class="extype" name="java.lang">lang</span>] </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="getClass():Class[_]"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#getClass():Class[_]" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd> |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#hashCode" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="hashCode():Int"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#hashCode():Int" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd> |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.Any#isInstanceOf" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#isInstanceOf[T0]:Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#ne(x$1:AnyRef):Boolean" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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="../../../../../scala/index.html#AnyRef=Object" class="extmbr" name="scala.AnyRef">AnyRef</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notify():Unit"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#notify():Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#notifyAll" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notifyAll():Unit"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#notifyAll():Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#synchronized" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](⇒T0):T0"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#synchronized[T0](x$1:=>T0):T0" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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> |
| |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#toString" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toString():String"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#toString():String" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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> |
| |
| <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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait():Unit"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#wait():Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </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" class="indented0 " 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> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </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" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> |
| <span class="permalink"> |
| <a href="../../../../../org/apache/spark/mllib/optimization/HingeGradient.html#wait(x$1:Long):Unit" title="Permalink"> |
| <i class="material-icons"></i> |
| </a> |
| </span> |
| <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: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </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> |
| |
| <span class="name">@native</span><span class="args">()</span> |
| |
| </dd></dl></div> |
| </li> |
| </ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| <div class="parent" name="org.apache.spark.mllib.optimization.Gradient"> |
| <h3>Inherited from <a href="Gradient.html" class="extype" name="org.apache.spark.mllib.optimization.Gradient">Gradient</a></h3> |
| </div><div class="parent" name="scala.Serializable"> |
| <h3>Inherited from <span class="extype" name="scala.Serializable">Serializable</span></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="../../../../../scala/index.html#AnyRef=Object" class="extmbr" name="scala.AnyRef">AnyRef</a></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> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |