| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="K-means Classification"><meta name="keywords" content="rust, rustlang, rust-lang, k_means"><title>rusty_machine::learning::k_means - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module k_means</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">learning</a>::<wbr><a class="mod" href="#">k_means</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/rusty_machine/learning/k_means.rs.html#1-381">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>K-means Classification</p> |
| <p>Provides implementation of K-Means classification.</p> |
| <h2 id="usage"><a href="#usage">Usage</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rusty_machine::linalg::Matrix; |
| <span class="kw">use </span>rusty_machine::learning::k_means::KMeansClassifier; |
| <span class="kw">use </span>rusty_machine::learning::UnSupModel; |
| |
| <span class="kw">let </span>inputs = Matrix::new(<span class="number">3</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">1.0</span>, <span class="number">3.0</span>, <span class="number">1.0</span>, <span class="number">4.0</span>]); |
| <span class="kw">let </span>test_inputs = Matrix::new(<span class="number">1</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">3.5</span>]); |
| |
| <span class="comment">// Create model with k(=2) classes. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>model = KMeansClassifier::new(<span class="number">2</span>); |
| |
| <span class="comment">// Where inputs is a Matrix with features in columns. |
| </span>model.train(<span class="kw-2">&</span>inputs).unwrap(); |
| |
| <span class="comment">// Where test_inputs is a Matrix with features in columns. |
| </span><span class="kw">let </span>a = model.predict(<span class="kw-2">&</span>test_inputs).unwrap();</code></pre></div> |
| <p>Additionally you can control the initialization |
| algorithm and max number of iterations.</p> |
| <h2 id="initializations"><a href="#initializations">Initializations</a></h2> |
| <p>Three initialization algorithms are supported.</p> |
| <h3 id="forgy-initialization"><a href="#forgy-initialization">Forgy initialization</a></h3> |
| <p>Choose initial centroids randomly from the data.</p> |
| <h3 id="random-partition-initialization"><a href="#random-partition-initialization">Random Partition initialization</a></h3> |
| <p>Randomly assign each data point to one of k clusters. |
| The initial centroids are the mean of the data in their class.</p> |
| <h3 id="k-means-initialization"><a href="#k-means-initialization">K-means++ initialization</a></h3> |
| <p>The <a href="https://en.wikipedia.org/wiki/K-means%2B%2B">k-means++</a> scheme.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Forgy.html" title="rusty_machine::learning::k_means::Forgy struct">Forgy</a></div><div class="item-right docblock-short">The Forgy initialization scheme.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.KMeansClassifier.html" title="rusty_machine::learning::k_means::KMeansClassifier struct">KMeansClassifier</a></div><div class="item-right docblock-short">K-Means Classification model.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.KPlusPlus.html" title="rusty_machine::learning::k_means::KPlusPlus struct">KPlusPlus</a></div><div class="item-right docblock-short">The K-means ++ initialization scheme.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RandomPartition.html" title="rusty_machine::learning::k_means::RandomPartition struct">RandomPartition</a></div><div class="item-right docblock-short">The Random Partition initialization scheme.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Initializer.html" title="rusty_machine::learning::k_means::Initializer trait">Initializer</a></div><div class="item-right docblock-short">Trait for algorithms initializing the K-means centroids.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rusty_machine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
