| <!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 supervised model."><meta name="keywords" content="rust, rustlang, rust-lang, SupModel"><title>SupModel 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">☰</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="#">SupModel</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="#">SupModel</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#154-160">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SupModel<T, U> { |
| fn <a href="#tymethod.predict" class="fnname">predict</a>(&self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a><U>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.train" class="fnname">train</a>(&mut self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, targets: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>U) -> <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for supervised 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#156">source</a><h4 class="code-header">fn <a href="#tymethod.predict" class="fnname">predict</a>(&self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a><U></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#159">source</a><h4 class="code-header">fn <a href="#tymethod.train" class="fnname">train</a>(&mut self, inputs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, targets: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>U) -> <a class="type" href="type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Train the model using inputs and targets.</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-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-LinRegressor" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/lin_reg.rs.html#66-106">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-LinRegressor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="lin_reg/struct.LinRegressor.html" title="struct rusty_machine::learning::lin_reg::LinRegressor">LinRegressor</a></h3></section><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-LogisticRegressor%3CA%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/logistic_reg.rs.html#100-144">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-LogisticRegressor%3CA%3E" class="anchor"></a><h3 class="code-header">impl<A> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="logistic_reg/struct.LogisticRegressor.html" title="struct rusty_machine::learning::logistic_reg::LogisticRegressor">LogisticRegressor</a><A><span class="where fmt-newline">where<br> A: <a class="trait" href="optim/trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><<a class="struct" href="logistic_reg/struct.BaseLogisticRegressor.html" title="struct rusty_machine::learning::logistic_reg::BaseLogisticRegressor">BaseLogisticRegressor</a>>,</span></h3></section><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-GenLinearModel%3CC%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/glm.rs.html#80-140">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-GenLinearModel%3CC%3E" class="anchor"></a><h3 class="code-header">impl<C: <a class="trait" href="glm/trait.Criterion.html" title="trait rusty_machine::learning::glm::Criterion">Criterion</a>> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="glm/struct.GenLinearModel.html" title="struct rusty_machine::learning::glm::GenLinearModel">GenLinearModel</a><C></h3></section><div class="docblock"><p>Supervised model trait for the GLM.</p> |
| <p>Predictions are made from the model by computing g^-1(Xb).</p> |
| <p>The model is trained using Iteratively Re-weighted Least Squares.</p> |
| </div><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-SVM%3CK%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/svm.rs.html#126-172">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-SVM%3CK%3E" class="anchor"></a><h3 class="code-header">impl<K: <a class="trait" href="toolkit/kernel/trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="svm/struct.SVM.html" title="struct rusty_machine::learning::svm::SVM">SVM</a><K></h3></section><div class="docblock"><p>Train the model using the Pegasos algorithm and |
| predict the model output from new data.</p> |
| </div><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cusize%3E%3E-for-KNNClassifier%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/knn/mod.rs.html#107-140">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cusize%3E%3E-for-KNNClassifier%3CS%3E" class="anchor"></a><h3 class="code-header">impl<S: <a class="trait" href="knn/trait.KNearestSearch.html" title="trait rusty_machine::learning::knn::KNearestSearch">KNearestSearch</a>> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>> for <a class="struct" href="knn/struct.KNNClassifier.html" title="struct rusty_machine::learning::knn::KNNClassifier">KNNClassifier</a><S></h3></section><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-NeuralNet%3CT%2C%20A%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/nnet/mod.rs.html#79-94">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-NeuralNet%3CT%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T, A> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="nnet/struct.NeuralNet.html" title="struct rusty_machine::learning::nnet::NeuralNet">NeuralNet</a><T, A><span class="where fmt-newline">where<br> T: <a class="trait" href="nnet/trait.Criterion.html" title="trait rusty_machine::learning::nnet::Criterion">Criterion</a>,<br> A: <a class="trait" href="optim/trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><<a class="struct" href="nnet/struct.BaseNeuralNet.html" title="struct rusty_machine::learning::nnet::BaseNeuralNet">BaseNeuralNet</a><T>>,</span></h3></section><div class="docblock"><p>Supervised learning for the Neural Network.</p> |
| <p>The model is trained using back propagation.</p> |
| </div><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-NaiveBayes%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/naive_bayes.rs.html#107-134">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Matrix%3Cf64%3E%3E-for-NaiveBayes%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: <a class="trait" href="naive_bayes/trait.Distribution.html" title="trait rusty_machine::learning::naive_bayes::Distribution">Distribution</a>> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="naive_bayes/struct.NaiveBayes.html" title="struct rusty_machine::learning::naive_bayes::NaiveBayes">NaiveBayes</a><T></h3></section><div class="docblock"><p>Train and predict from the Naive Bayes model.</p> |
| <p>The input matrix must be rows made up of features. |
| The target matrix should have indicator vectors in each row specifying |
| the input class. e.g. [[1,0,0],[0,0,1]] shows class 1 first, then class 3.</p> |
| </div><section id="impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-GaussianProcess%3CT%2C%20U%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rusty_machine/learning/gp.rs.html#143-177">source</a><a href="#impl-SupModel%3CMatrix%3Cf64%3E%2C%20Vector%3Cf64%3E%3E-for-GaussianProcess%3CT%2C%20U%3E" class="anchor"></a><h3 class="code-header">impl<T: <a class="trait" href="toolkit/kernel/trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>, U: <a class="trait" href="gp/trait.MeanFunc.html" title="trait rusty_machine::learning::gp::MeanFunc">MeanFunc</a>> <a class="trait" href="trait.SupModel.html" title="trait rusty_machine::learning::SupModel">SupModel</a><<a class="struct" href="../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>> for <a class="struct" href="gp/struct.GaussianProcess.html" title="struct rusty_machine::learning::gp::GaussianProcess">GaussianProcess</a><T, U></h3></section></div><script src="../../implementors/rusty_machine/learning/trait.SupModel.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> |
