| <!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_291) on Mon Jan 10 11:05:28 MSK 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>KMeansModel (Ignite 2.12.0)</title> |
| <meta name="date" content="2022-01-10"> |
| <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="KMeansModel (Ignite 2.12.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/KMeansModel.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/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.KMeansJSONExportModel.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" target="_top">Frames</a></li> |
| <li><a href="KMeansModel.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 KMeansModel" class="title">Class KMeansModel</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>org.apache.ignite.ml.clustering.kmeans.KMeansModel</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans">ClusterizationModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span>, <a href="../../../../../../org/apache/ignite/ml/environment/deploy/DeployableObject.html" title="interface in org.apache.ignite.ml.environment.deploy">DeployableObject</a>, <a href="../../../../../../org/apache/ignite/ml/Exportable.html" title="interface in org.apache.ignite.ml">Exportable</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModelFormat</a><span class='angle_bracket'>></span>, <a href="../../../../../../org/apache/ignite/ml/IgniteModel.html" title="interface in org.apache.ignite.ml">IgniteModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span>, <a href="../../../../../../org/apache/ignite/ml/inference/json/JSONWritable.html" title="interface in org.apache.ignite.ml.inference.json">JSONWritable</a>, <a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference">Model</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">KMeansModel</span> |
| extends <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> |
| implements <a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans">ClusterizationModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span>, <a href="../../../../../../org/apache/ignite/ml/Exportable.html" title="interface in org.apache.ignite.ml">Exportable</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModelFormat</a><span class='angle_bracket'>></span>, <a href="../../../../../../org/apache/ignite/ml/inference/json/JSONWritable.html" title="interface in org.apache.ignite.ml.inference.json">JSONWritable</a>, <a href="../../../../../../org/apache/ignite/ml/environment/deploy/DeployableObject.html" title="interface in org.apache.ignite.ml.environment.deploy">DeployableObject</a></pre> |
| <div class="block">This class encapsulates result of clusterization by KMeans algorithm.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.ignite.ml.clustering.kmeans.KMeansModel">Serialized Form</a></dd> |
| </dl> |
| </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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.KMeansJSONExportModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel.KMeansJSONExportModel</a></span></code> </td> |
| </tr> |
| </table> |
| </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"> </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/KMeansModel.html#KMeansModel-org.apache.ignite.ml.math.primitives.vector.Vector:A-org.apache.ignite.ml.math.distances.DistanceMeasure-">KMeansModel</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[] centers, |
| <a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a> distanceMeasure)</code> |
| <div class="block">Construct KMeans model with given centers and distanceMeasure measure.</div> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#amountOfClusters--">amountOfClusters</a></span>()</code> |
| <div class="block">Gets the clusters count.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#centers--">centers</a></span>()</code> |
| <div class="block">Get cluster centers.</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/KMeansModel.html#distanceMeasure--">distanceMeasure</a></span>()</code> |
| <div class="block">Distance measure.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#equals-java.lang.Object-">equals</a></span>(<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> obj)</code></td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <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/KMeansModel.html#fromJSON-java.nio.file.Path-">fromJSON</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</code> |
| <div class="block">Loads KMeansModel from JSON file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><span class='angle_bracket'><</span><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><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#getDependencies--">getDependencies</a></span>()</code> |
| <div class="block">Returns dependencies of this object that can be object with class defined by client side and unknown for server.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#hashCode--">hashCode</a></span>()</code></td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#predict-org.apache.ignite.ml.math.primitives.vector.Vector-">predict</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a> vec)</code> |
| <div class="block">Make a prediction for the specified input arguments.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>P<span class='angle_bracket'>></span> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#saveModel-org.apache.ignite.ml.Exporter-P-">saveModel</a></span>(<a href="../../../../../../org/apache/ignite/ml/Exporter.html" title="interface in org.apache.ignite.ml">Exporter</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModelFormat</a>,P<span class='angle_bracket'>></span> exporter, |
| P path)</code> |
| <div class="block">Save model by the given path.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#toJSON-java.nio.file.Path-">toJSON</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</code></td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#toString--">toString</a></span>()</code></td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html#toString-boolean-">toString</a></span>(boolean pretty)</code></td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><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/KMeansModel.html#withCentroids-org.apache.ignite.ml.math.primitives.vector.Vector:A-">withCentroids</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[] centers)</code> |
| <div class="block">Set up the centroids.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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/KMeansModel.html#withDistanceMeasure-org.apache.ignite.ml.math.distances.DistanceMeasure-">withDistanceMeasure</a></span>(<a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a> distanceMeasure)</code> |
| <div class="block">Set up the distance measure.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#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#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#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.ml.IgniteModel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.ignite.ml.<a href="../../../../../../org/apache/ignite/ml/IgniteModel.html" title="interface in org.apache.ignite.ml">IgniteModel</a></h3> |
| <code><a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#andBefore-org.apache.ignite.ml.math.functions.IgniteFunction-">andBefore</a>, <a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#andThen-org.apache.ignite.ml.math.functions.IgniteFunction-">andThen</a>, <a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#andThen-org.apache.ignite.ml.IgniteModel-">andThen</a>, <a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#close--">close</a>, <a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#combine-org.apache.ignite.ml.IgniteModel-java.util.function.BiFunction-">combine</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="KMeansModel-org.apache.ignite.ml.math.primitives.vector.Vector:A-org.apache.ignite.ml.math.distances.DistanceMeasure-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>KMeansModel</h4> |
| <pre>public KMeansModel(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[] centers, |
| <a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a> distanceMeasure)</pre> |
| <div class="block">Construct KMeans model with given centers and distanceMeasure measure.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>centers</code> - Centers.</dd> |
| <dd><code>distanceMeasure</code> - Distance measure.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="distanceMeasure--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distanceMeasure</h4> |
| <pre>public <a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a> distanceMeasure()</pre> |
| <div class="block">Distance measure.</div> |
| </li> |
| </ul> |
| <a name="amountOfClusters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>amountOfClusters</h4> |
| <pre>public int amountOfClusters()</pre> |
| <div class="block">Gets the clusters count.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html#amountOfClusters--">amountOfClusters</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans">ClusterizationModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withCentroids-org.apache.ignite.ml.math.primitives.vector.Vector:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCentroids</h4> |
| <pre>public <a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a> withCentroids(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[] centers)</pre> |
| <div class="block">Set up the centroids.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>centers</code> - The parameter value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Model with new centers parameter value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDistanceMeasure-org.apache.ignite.ml.math.distances.DistanceMeasure-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDistanceMeasure</h4> |
| <pre>public <a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a> withDistanceMeasure(<a href="../../../../../../org/apache/ignite/ml/math/distances/DistanceMeasure.html" title="interface in org.apache.ignite.ml.math.distances">DistanceMeasure</a> distanceMeasure)</pre> |
| <div class="block">Set up the distance measure.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>distanceMeasure</code> - The parameter value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Model with new distance measure parameter value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="centers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>centers</h4> |
| <pre>public <a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>[] centers()</pre> |
| <div class="block">Get cluster centers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html#centers--">centers</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans">ClusterizationModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="predict-org.apache.ignite.ml.math.primitives.vector.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>predict</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> predict(<a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a> vec)</pre> |
| <div class="block">Make a prediction for the specified input arguments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/inference/Model.html#predict-I-">predict</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/inference/Model.html" title="interface in org.apache.ignite.ml.inference">Model</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vec</code> - Input arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Prediction result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="saveModel-org.apache.ignite.ml.Exporter-java.lang.Object-"> |
| <!-- --> |
| </a><a name="saveModel-org.apache.ignite.ml.Exporter-P-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveModel</h4> |
| <pre>public <span class='angle_bracket'><</span>P<span class='angle_bracket'>></span> void saveModel(<a href="../../../../../../org/apache/ignite/ml/Exporter.html" title="interface in org.apache.ignite.ml">Exporter</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModelFormat</a>,P<span class='angle_bracket'>></span> exporter, |
| P path)</pre> |
| <div class="block">Save model by the given path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/Exportable.html#saveModel-org.apache.ignite.ml.Exporter-P-">saveModel</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/Exportable.html" title="interface in org.apache.ignite.ml">Exportable</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModelFormat.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModelFormat</a><span class='angle_bracket'>></span></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exporter</code> - Exporter.</dd> |
| <dd><code>path</code> - Path to saved model.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<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> obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(boolean pretty)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/IgniteModel.html#toString-boolean-">toString</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/IgniteModel.html" title="interface in org.apache.ignite.ml">IgniteModel</a><span class='angle_bracket'><</span><a href="../../../../../../org/apache/ignite/ml/math/primitives/vector/Vector.html" title="interface in org.apache.ignite.ml.math.primitives.vector">Vector</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a><span class='angle_bracket'>></span></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pretty</code> - Use pretty mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDependencies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDependencies</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><span class='angle_bracket'><</span><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><span class='angle_bracket'>></span> getDependencies()</pre> |
| <div class="block">Returns dependencies of this object that can be object with class defined by client side and unknown for server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/environment/deploy/DeployableObject.html#getDependencies--">getDependencies</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/environment/deploy/DeployableObject.html" title="interface in org.apache.ignite.ml.environment.deploy">DeployableObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromJSON-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromJSON</h4> |
| <pre>public static <a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" title="class in org.apache.ignite.ml.clustering.kmeans">KMeansModel</a> fromJSON(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</pre> |
| <div class="block">Loads KMeansModel from JSON file.</div> |
| </li> |
| </ul> |
| <a name="toJSON-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toJSON</h4> |
| <pre>public void toJSON(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> path)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/ignite/ml/inference/json/JSONWritable.html#toJSON-java.nio.file.Path-">toJSON</a></code> in interface <code><a href="../../../../../../org/apache/ignite/ml/inference/json/JSONWritable.html" title="interface in org.apache.ignite.ml.inference.json">JSONWritable</a></code></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/KMeansModel.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/ClusterizationModel.html" title="interface in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/ignite/ml/clustering/kmeans/KMeansModel.KMeansJSONExportModel.html" title="class in org.apache.ignite.ml.clustering.kmeans"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/ignite/ml/clustering/kmeans/KMeansModel.html" target="_top">Frames</a></li> |
| <li><a href="KMeansModel.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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>2022 Copyright © 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>: ver. <strong>2.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
