Google Git
Sign in
apache / spark-website / 24535be02130e0d53fa589767a053d3747c7ae3b / . / site / docs / 3.3.4 / api / java / org / apache / spark / ml / MLEvents.html
blob: 999b96b03898da3469b9f07907c36feb654e9e26 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Dec 08 19:54:28 UTC 2023 -->
<title>MLEvents (Spark 3.3.4 JavaDoc)</title>
<meta name="date" content="2023-12-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MLEvents (Spark 3.3.4 JavaDoc)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/ml/MLEvents.html" target="_top">Frames</a></li>
<li><a href="MLEvents.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.ml</div>
<h2 title="Interface MLEvents" class="title">Interface MLEvents</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.apache.spark.internal.Logging</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MLEvents</span>
extends org.apache.spark.internal.Logging</pre>
<div class="block">A small trait that defines some methods to send <a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml"><code>MLEvent</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.spark.internal.Logging">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.spark.internal.Logging</h3>
<code>org.apache.spark.internal.Logging.SparkShellLoggingFilter</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.spark.scheduler.LiveListenerBus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#listenerBus--">listenerBus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#logEvent-org.apache.spark.ml.MLEvent-">logEvent</a></span>(<a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml">MLEvent</a>&nbsp;event)</code>
<div class="block">Log <a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml"><code>MLEvent</code></a> to send.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;M extends <a href="../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a>&lt;M&gt;&gt;<br>M</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#withFitEvent-org.apache.spark.ml.Estimator-org.apache.spark.sql.Dataset-scala.Function0-">withFitEvent</a></span>(<a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>&lt;M&gt;&nbsp;estimator,
<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset,
scala.Function0&lt;M&gt;&nbsp;func)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#withLoadInstanceEvent-org.apache.spark.ml.util.MLReader-java.lang.String-scala.Function0-">withLoadInstanceEvent</a></span>(<a href="../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a>&lt;T&gt;&nbsp;reader,
String&nbsp;path,
scala.Function0&lt;T&gt;&nbsp;func)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#withSaveInstanceEvent-org.apache.spark.ml.util.MLWriter-java.lang.String-scala.Function0-">withSaveInstanceEvent</a></span>(<a href="../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a>&nbsp;writer,
String&nbsp;path,
scala.Function0&lt;scala.runtime.BoxedUnit&gt;&nbsp;func)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/MLEvents.html#withTransformEvent-org.apache.spark.ml.Transformer-org.apache.spark.sql.Dataset-scala.Function0-">withTransformEvent</a></span>(<a href="../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a>&nbsp;transformer,
<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;input,
scala.Function0&lt;<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&gt;&nbsp;func)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.internal.Logging">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.internal.Logging</h3>
<code>$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="listenerBus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listenerBus</h4>
<pre>org.apache.spark.scheduler.LiveListenerBus&nbsp;listenerBus()</pre>
</li>
</ul>
<a name="logEvent-org.apache.spark.ml.MLEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logEvent</h4>
<pre>void&nbsp;logEvent(<a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml">MLEvent</a>&nbsp;event)</pre>
<div class="block">Log <a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml"><code>MLEvent</code></a> to send. By default, it emits a debug-level log.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - (undocumented)</dd>
</dl>
</li>
</ul>
<a name="withFitEvent-org.apache.spark.ml.Estimator-org.apache.spark.sql.Dataset-scala.Function0-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withFitEvent</h4>
<pre>&lt;M extends <a href="../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a>&lt;M&gt;&gt;&nbsp;M&nbsp;withFitEvent(<a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>&lt;M&gt;&nbsp;estimator,
<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset,
scala.Function0&lt;M&gt;&nbsp;func)</pre>
</li>
</ul>
<a name="withLoadInstanceEvent-org.apache.spark.ml.util.MLReader-java.lang.String-scala.Function0-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withLoadInstanceEvent</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;withLoadInstanceEvent(<a href="../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a>&lt;T&gt;&nbsp;reader,
String&nbsp;path,
scala.Function0&lt;T&gt;&nbsp;func)</pre>
</li>
</ul>
<a name="withSaveInstanceEvent-org.apache.spark.ml.util.MLWriter-java.lang.String-scala.Function0-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSaveInstanceEvent</h4>
<pre>void&nbsp;withSaveInstanceEvent(<a href="../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a>&nbsp;writer,
String&nbsp;path,
scala.Function0&lt;scala.runtime.BoxedUnit&gt;&nbsp;func)</pre>
</li>
</ul>
<a name="withTransformEvent-org.apache.spark.ml.Transformer-org.apache.spark.sql.Dataset-scala.Function0-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withTransformEvent</h4>
<pre><a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&nbsp;withTransformEvent(<a href="../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a>&nbsp;transformer,
<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;input,
scala.Function0&lt;<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;<a href="../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>&gt;&gt;&nbsp;func)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/spark/ml/MLEvent.html" title="interface in org.apache.spark.ml"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/ml/MLEvents.html" target="_top">Frames</a></li>
<li><a href="MLEvents.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../lib/api-javadocs.js"></script></body>
</html>