Google Git
Sign in
apache / ignite-website / 63e70a26b8e6d02cb8fd13a3d0793de3275cc10e / . / releases / 2.11.1 / javadoc / org / apache / ignite / ml / clustering / kmeans / KMeansTrainer.html
blob: 9ceab0d37d820ec62bf4e6f2360d2bb366ce520d [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_261) on Mon Dec 20 14:15:55 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>KMeansTrainer (Ignite 2.11.1)</title>
<meta name="date" content="2021-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KMeansTrainer (Ignite 2.11.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/KMeansTrainer.html">Use</a></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/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.TotalCostAndCounts.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" target="_top">Frames</a></li>
<li><a href="KMeansTrainer.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.ignite.ml.trainers.DatasetTrainer">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.ignite.ml.clustering.kmeans</div>
<h2 title="Class KMeansTrainer" class="title">Class KMeansTrainer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">org.apache.ignite.ml.trainers.DatasetTrainer</a><span class='angle_bracket'>&lt;</span>M,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a><span class='angle_bracket'>&gt;</span></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/ignite/ml/trainers/SingleLabelDatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">org.apache.ignite.ml.trainers.SingleLabelDatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a><span class='angle_bracket'>&gt;</span></li>
<li>
<ul class="inheritance">
<li>org.apache.ignite.ml.clustering.kmeans.KMeansTrainer</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">KMeansTrainer</span>
extends <a href="../../../../../../org/apache/ignite/ml/trainers/SingleLabelDatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">SingleLabelDatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a><span class='angle_bracket'>&gt;</span></pre>
<div class="block">The trainer for KMeans algorithm.</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.TotalCostAndCounts.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer.TotalCostAndCounts</a></span></code>
<div class="block">Service class used for statistics.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.ignite.ml.trainers.DatasetTrainer">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.ignite.ml.trainers.<a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a></h3>
<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.EmptyDatasetException.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer.EmptyDatasetException</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.ignite.ml.trainers.DatasetTrainer">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.ignite.ml.trainers.<a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a></h3>
<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#envBuilder">envBuilder</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#environment">environment</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#KMeansTrainer--">KMeansTrainer</a></span>()</code>&nbsp;</td>
</tr>
</table>
</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#fitWithInitializedDeployingContext-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">fitWithInitializedDeployingContext</a></span>(<a href="../../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset">DatasetBuilder</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;datasetBuilder,
<a href="../../../../../../org/apache/ignite/ml/preprocessing/Preprocessor.html" title="interface in org.apache.ignite.ml.preprocessing">Preprocessor</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;preprocessor)</code>
<div class="block">Trains model based on the specified data.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#getAmountOfClusters--">getAmountOfClusters</a></span>()</code>
<div class="block">Gets the amount of clusters.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#getDistance--">getDistance</a></span>()</code>
<div class="block">Gets the distance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#getEpsilon--">getEpsilon</a></span>()</code>
<div class="block">Gets the epsilon.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#getMaxIterations--">getMaxIterations</a></span>()</code>
<div class="block">Gets the max number of iterations before convergence.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#isUpdateable-org.apache.ignite.ml.clustering.kmeans.KMeansModel-">isUpdateable</a></span>(<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;mdl)</code></td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#updateModel-org.apache.ignite.ml.clustering.kmeans.KMeansModel-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">updateModel</a></span>(<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;mdl,
<a href="../../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset">DatasetBuilder</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;datasetBuilder,
<a href="../../../../../../org/apache/ignite/ml/preprocessing/Preprocessor.html" title="interface in org.apache.ignite.ml.preprocessing">Preprocessor</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;preprocessor)</code>
<div class="block">Gets state of model in arguments, update in according to new data and return new model.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#withAmountOfClusters-int-">withAmountOfClusters</a></span>(int&nbsp;k)</code>
<div class="block">Set up the amount of clusters.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#withDistance-org.apache.ignite.ml.math.distances.DistanceMeasure-">withDistance</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a>&nbsp;distance)</code>
<div class="block">Set up the distance.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#withEnvironmentBuilder-org.apache.ignite.ml.environment.LearningEnvironmentBuilder-">withEnvironmentBuilder</a></span>(<a href="../../../../../../org/apache/ignite/ml/environment/LearningEnvironmentBuilder.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironmentBuilder</a>&nbsp;envBuilder)</code>
<div class="block">Changes learning Environment.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#withEpsilon-double-">withEpsilon</a></span>(double&nbsp;epsilon)</code>
<div class="block">Set up the epsilon.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html#withMaxIterations-int-">withMaxIterations</a></span>(int&nbsp;maxIterations)</code>
<div class="block">Set up the max number of iterations before convergence.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.ml.trainers.DatasetTrainer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.ignite.ml.trainers.<a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a></h3>
<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-org.apache.ignite.ml.environment.LearningEnvironment-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-org.apache.ignite.Ignite-org.apache.ignite.IgniteCache-org.apache.ignite.lang.IgniteBiPredicate-org.apache.ignite.ml.preprocessing.Preprocessor-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-org.apache.ignite.Ignite-org.apache.ignite.IgniteCache-org.apache.ignite.ml.preprocessing.Preprocessor-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-java.util.Map-org.apache.ignite.lang.IgniteBiPredicate-int-org.apache.ignite.ml.preprocessing.Preprocessor-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fit-java.util.Map-int-org.apache.ignite.ml.preprocessing.Preprocessor-">fit</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#getLastTrainedModelOrThrowEmptyDatasetException-M-">getLastTrainedModelOrThrowEmptyDatasetException</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#identityTrainer--">identityTrainer</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#learningEnvironment--">learningEnvironment</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#update-M-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">update</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#update-M-org.apache.ignite.Ignite-org.apache.ignite.IgniteCache-org.apache.ignite.lang.IgniteBiPredicate-org.apache.ignite.ml.preprocessing.Preprocessor-">update</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#update-M-org.apache.ignite.Ignite-org.apache.ignite.IgniteCache-org.apache.ignite.ml.preprocessing.Preprocessor-">update</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#update-M-java.util.Map-org.apache.ignite.lang.IgniteBiPredicate-int-org.apache.ignite.ml.preprocessing.Preprocessor-">update</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#update-M-java.util.Map-int-org.apache.ignite.ml.preprocessing.Preprocessor-">update</a>, <a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#withConvertedLabels-org.apache.ignite.ml.math.functions.IgniteFunction-">withConvertedLabels</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KMeansTrainer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KMeansTrainer</h4>
<pre>public&nbsp;KMeansTrainer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fitWithInitializedDeployingContext-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fitWithInitializedDeployingContext</h4>
<pre>public&nbsp;<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;fitWithInitializedDeployingContext(<a href="../../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset">DatasetBuilder</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;datasetBuilder,
<a href="../../../../../../org/apache/ignite/ml/preprocessing/Preprocessor.html" title="interface in org.apache.ignite.ml.preprocessing">Preprocessor</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;preprocessor)</pre>
<div class="block">Trains model based on the specified data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#fitWithInitializedDeployingContext-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">fitWithInitializedDeployingContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of a key in <code>upstream</code> data.</dd>
<dd><code>V</code> - Type of a value in <code>upstream</code> data.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datasetBuilder</code> - Dataset builder.</dd>
<dd><code>preprocessor</code> - Extractor of <a href="../../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset"><code>UpstreamEntry</code></a> into <a href="../../../../../../org/apache/ignite/ml/structures/LabeledVector.html" title="class in org.apache.ignite.ml.structures"><code>LabeledVector</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Model.</dd>
</dl>
</li>
</ul>
<a name="withEnvironmentBuilder-org.apache.ignite.ml.environment.LearningEnvironmentBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEnvironmentBuilder</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a>&nbsp;withEnvironmentBuilder(<a href="../../../../../../org/apache/ignite/ml/environment/LearningEnvironmentBuilder.html" title="interface in org.apache.ignite.ml.environment">LearningEnvironmentBuilder</a>&nbsp;envBuilder)</pre>
<div class="block">Changes learning Environment.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#withEnvironmentBuilder-org.apache.ignite.ml.environment.LearningEnvironmentBuilder-">withEnvironmentBuilder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>envBuilder</code> - Learning environment builder.</dd>
</dl>
</li>
</ul>
<a name="updateModel-org.apache.ignite.ml.clustering.kmeans.KMeansModel-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateModel</h4>
<pre>protected&nbsp;<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;updateModel(<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;mdl,
<a href="../../../../../../org/apache/ignite/ml/dataset/DatasetBuilder.html" title="interface in org.apache.ignite.ml.dataset">DatasetBuilder</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;datasetBuilder,
<a href="../../../../../../org/apache/ignite/ml/preprocessing/Preprocessor.html" title="interface in org.apache.ignite.ml.preprocessing">Preprocessor</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;preprocessor)</pre>
<div class="block">Gets state of model in arguments, update in according to new data and return new model.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#updateModel-M-org.apache.ignite.ml.dataset.DatasetBuilder-org.apache.ignite.ml.preprocessing.Preprocessor-">updateModel</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of a key in <code>upstream</code> data.</dd>
<dd><code>V</code> - Type of a value in <code>upstream</code> data.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mdl</code> - Learned model.</dd>
<dd><code>datasetBuilder</code> - Dataset builder.</dd>
<dd><code>preprocessor</code> - Extractor of <a href="../../../../../../org/apache/ignite/ml/dataset/UpstreamEntry.html" title="class in org.apache.ignite.ml.dataset"><code>UpstreamEntry</code></a> into <a href="../../../../../../org/apache/ignite/ml/structures/LabeledVector.html" title="class in org.apache.ignite.ml.structures"><code>LabeledVector</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Updated model.</dd>
</dl>
</li>
</ul>
<a name="isUpdateable-org.apache.ignite.ml.clustering.kmeans.KMeansModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpdateable</h4>
<pre>public&nbsp;boolean&nbsp;isUpdateable(<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>&nbsp;mdl)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html#isUpdateable-M-">isUpdateable</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/ignite/ml/trainers/DatasetTrainer.html" title="class in org.apache.ignite.ml.trainers">DatasetTrainer</a><span class='angle_bracket'>&lt;</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mdl</code> - Model.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if current critical for training parameters correspond to parameters from last training.</dd>
</dl>
</li>
</ul>
<a name="getAmountOfClusters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAmountOfClusters</h4>
<pre>public&nbsp;int&nbsp;getAmountOfClusters()</pre>
<div class="block">Gets the amount of clusters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parameter value.</dd>
</dl>
</li>
</ul>
<a name="withAmountOfClusters-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAmountOfClusters</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a>&nbsp;withAmountOfClusters(int&nbsp;k)</pre>
<div class="block">Set up the amount of clusters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>k</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Model with new amount of clusters parameter value.</dd>
</dl>
</li>
</ul>
<a name="getMaxIterations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIterations</h4>
<pre>public&nbsp;int&nbsp;getMaxIterations()</pre>
<div class="block">Gets the max number of iterations before convergence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parameter value.</dd>
</dl>
</li>
</ul>
<a name="withMaxIterations-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withMaxIterations</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a>&nbsp;withMaxIterations(int&nbsp;maxIterations)</pre>
<div class="block">Set up the max number of iterations before convergence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxIterations</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Model with new max number of iterations before convergence parameter value.</dd>
</dl>
</li>
</ul>
<a name="getEpsilon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEpsilon</h4>
<pre>public&nbsp;double&nbsp;getEpsilon()</pre>
<div class="block">Gets the epsilon.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parameter value.</dd>
</dl>
</li>
</ul>
<a name="withEpsilon-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEpsilon</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a>&nbsp;withEpsilon(double&nbsp;epsilon)</pre>
<div class="block">Set up the epsilon.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>epsilon</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Model with new epsilon parameter value.</dd>
</dl>
</li>
</ul>
<a name="getDistance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistance</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a>&nbsp;getDistance()</pre>
<div class="block">Gets the distance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parameter value.</dd>
</dl>
</li>
</ul>
<a name="withDistance-org.apache.ignite.ml.math.distances.DistanceMeasure-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withDistance</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansTrainer</a>&nbsp;withDistance(<a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a>&nbsp;distance)</pre>
<div class="block">Set up the distance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>distance</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Model with new distance parameter value.</dd>
</dl>
</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="class-use/KMeansTrainer.html">Use</a></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/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.TotalCostAndCounts.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/ignite/ml/clustering/kmeans/KMeansTrainer.html" target="_top">Frames</a></li>
<li><a href="KMeansTrainer.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.ignite.ml.trainers.DatasetTrainer">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>