blob: 06ae8dbdcc2992ddfb06fe4c17e4137259db0cc2 [file] [log] [blame]
<!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="Trait for unsupervised model."><meta name="keywords" content="rust, rustlang, rust-lang, UnSupModel"><title>UnSupModel in rusty_machine::learning - 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="sidebar-items.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 trait"><!--[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">&#9776;</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="#">UnSupModel</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.predict">predict</a></li><li><a href="#tymethod.train">train</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning</a></h2></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">Trait <a href="../index.html">rusty_machine</a>::<wbr><a href="index.html">learning</a>::<wbr><a class="trait" href="#">UnSupModel</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/lib.rs.html#163-169">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait UnSupModel&lt;T, U&gt; {
fn <a href="#tymethod.predict" class="fnname">predict</a>(&amp;self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;U&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.train" class="fnname">train</a>(&amp;mut self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for unsupervised model.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.predict" class="method has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/lib.rs.html#165">source</a><h4 class="code-header">fn <a href="#tymethod.predict" class="fnname">predict</a>(&amp;self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;U&gt;</h4></section></summary><div class="docblock"><p>Predict output from inputs.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.train" class="method has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/lib.rs.html#168">source</a><h4 class="code-header">fn <a href="#tymethod.train" class="fnname">train</a>(&amp;mut self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Train the model using inputs.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-GaussianMixtureModel" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/gmm.rs.html#70-117">source</a><a href="#impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-GaussianMixtureModel" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.UnSupModel.html" title="trait rusty_machine::learning::UnSupModel">UnSupModel</a>&lt;<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;, <a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;&gt; for <a class="struct" href="gmm/struct.GaussianMixtureModel.html" title="struct rusty_machine::learning::gmm::GaussianMixtureModel">GaussianMixtureModel</a></h3></section><section id="impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-PCA" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/pca.rs.html#123-200">source</a><a href="#impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-PCA" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.UnSupModel.html" title="trait rusty_machine::learning::UnSupModel">UnSupModel</a>&lt;<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;, <a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;&gt; for <a class="struct" href="pca/struct.PCA.html" title="struct rusty_machine::learning::pca::PCA">PCA</a></h3></section><div class="docblock"><p>Train the model and predict the model output from new data.</p>
</div><section id="impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Vector%3COption%3Cusize%3E%3E%3E-for-DBSCAN" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/dbscan.rs.html#78-138">source</a><a href="#impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Vector%3COption%3Cusize%3E%3E%3E-for-DBSCAN" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.UnSupModel.html" title="trait rusty_machine::learning::UnSupModel">UnSupModel</a>&lt;<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;&gt;&gt; for <a class="struct" href="dbscan/struct.DBSCAN.html" title="struct rusty_machine::learning::dbscan::DBSCAN">DBSCAN</a></h3></section><section id="impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cusize%3E%3E-for-KMeansClassifier%3CInitAlg%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/k_means.rs.html#79-111">source</a><a href="#impl-UnSupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cusize%3E%3E-for-KMeansClassifier%3CInitAlg%3E" class="anchor"></a><h3 class="code-header">impl&lt;InitAlg:&nbsp;<a class="trait" href="k_means/trait.Initializer.html" title="trait rusty_machine::learning::k_means::Initializer">Initializer</a>&gt; <a class="trait" href="trait.UnSupModel.html" title="trait rusty_machine::learning::UnSupModel">UnSupModel</a>&lt;<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;&gt; for <a class="struct" href="k_means/struct.KMeansClassifier.html" title="struct rusty_machine::learning::k_means::KMeansClassifier">KMeansClassifier</a>&lt;InitAlg&gt;</h3></section></div><script src="../../implementors/rusty_machine/learning/trait.UnSupModel.js" async></script></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>