blob: c4a135b6c411d285181bee47f123d5106993fdb6 [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="Naive Bayes Classifiers"><meta name="keywords" content="rust, rustlang, rust-lang, naive_bayes"><title>rusty_machine::learning::naive_bayes - 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">&#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="#">Module naive_bayes</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="#">naive_bayes</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/naive_bayes.rs.html#1-505">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Naive Bayes Classifiers</p>
<p>The classifier supports Gaussian, Bernoulli and Multinomial distributions.</p>
<p>A naive Bayes classifier works by treating the features of each input as independent
observations. Under this assumption we utilize Bayes’ rule to compute the
probability that each input belongs to a given class.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rusty_machine::learning::naive_bayes::{NaiveBayes, Gaussian};
<span class="kw">use </span>rusty_machine::linalg::Matrix;
<span class="kw">use </span>rusty_machine::learning::SupModel;
<span class="kw">let </span>inputs = Matrix::new(<span class="number">6</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">1.1</span>,
<span class="number">1.1</span>, <span class="number">0.9</span>,
<span class="number">2.2</span>, <span class="number">2.3</span>,
<span class="number">2.5</span>, <span class="number">2.7</span>,
<span class="number">5.2</span>, <span class="number">4.3</span>,
<span class="number">6.2</span>, <span class="number">7.3</span>]);
<span class="kw">let </span>targets = Matrix::new(<span class="number">6</span>,<span class="number">3</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">0.0</span>, <span class="number">0.0</span>,
<span class="number">1.0</span>, <span class="number">0.0</span>, <span class="number">0.0</span>,
<span class="number">0.0</span>, <span class="number">1.0</span>, <span class="number">0.0</span>,
<span class="number">0.0</span>, <span class="number">1.0</span>, <span class="number">0.0</span>,
<span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">1.0</span>,
<span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">1.0</span>]);
<span class="comment">// Create a Gaussian Naive Bayes classifier.
</span><span class="kw">let </span><span class="kw-2">mut </span>model = NaiveBayes::&lt;Gaussian&gt;::new();
<span class="comment">// Train the model.
</span>model.train(<span class="kw-2">&amp;</span>inputs, <span class="kw-2">&amp;</span>targets).unwrap();
<span class="comment">// Predict the classes on the input data
</span><span class="kw">let </span>outputs = model.predict(<span class="kw-2">&amp;</span>inputs).unwrap();
<span class="comment">// Will output the target classes - otherwise our classifier is bad!
</span><span class="macro">println!</span>(<span class="string">&quot;Final outputs --\n{}&quot;</span>, outputs);</code></pre></div>
</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.Bernoulli.html" title="rusty_machine::learning::naive_bayes::Bernoulli struct">Bernoulli</a></div><div class="item-right docblock-short">The Bernoulli Naive Bayes model distribution.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Gaussian.html" title="rusty_machine::learning::naive_bayes::Gaussian struct">Gaussian</a></div><div class="item-right docblock-short">The Gaussian Naive Bayes model distribution.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Multinomial.html" title="rusty_machine::learning::naive_bayes::Multinomial struct">Multinomial</a></div><div class="item-right docblock-short">The Multinomial Naive Bayes model distribution.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NaiveBayes.html" title="rusty_machine::learning::naive_bayes::NaiveBayes struct">NaiveBayes</a></div><div class="item-right docblock-short">The Naive Bayes model.</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.Distribution.html" title="rusty_machine::learning::naive_bayes::Distribution trait">Distribution</a></div><div class="item-right docblock-short">Naive Bayes Distribution.</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>