| <!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="Randomly splits the inputs into k ‘folds’. For each fold a model is trained using all inputs except for that fold, and tested on the data in the fold. Returns the scores for each fold."><meta name="keywords" content="rust, rustlang, rust-lang, k_fold_validate"><title>k_fold_validate in rusty_machine::analysis::cross_validation - 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 fn"><!--[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><div class="sidebar-elems"><h2><a href="index.html">In rusty_machine::analysis::cross_validation</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">Function <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">analysis</a>::<wbr><a href="index.html">cross_validation</a>::<wbr><a class="fn" href="#">k_fold_validate</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/analysis/cross_validation.rs.html#48-76">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 fn"><code>pub fn k_fold_validate<M, S>(<br> model: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>M,<br> inputs: &<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>>,<br> targets: &<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>>,<br> k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,<br> score: S<br>) -> <a class="type" href="../../learning/type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>><span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</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>>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,<br> M: <a class="trait" href="../../learning/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>>>,</span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Randomly splits the inputs into k ‘folds’. For each fold a model |
| is trained using all inputs except for that fold, and tested on the |
| data in the fold. Returns the scores for each fold.</p> |
| <h2 id="arguments"><a href="#arguments">Arguments</a></h2> |
| <ul> |
| <li><code>model</code> - Used to train and predict for each fold.</li> |
| <li><code>inputs</code> - All input samples.</li> |
| <li><code>targets</code> - All targets.</li> |
| <li><code>k</code> - Number of folds to use.</li> |
| <li><code>score</code> - Used to compare the outputs for each fold to the targets. Higher scores are better. See the <code>analysis::score</code> module for examples.</li> |
| </ul> |
| <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::analysis::cross_validation::k_fold_validate; |
| <span class="kw">use </span>rusty_machine::analysis::score::row_accuracy; |
| <span class="kw">use </span>rusty_machine::learning::naive_bayes::{NaiveBayes, Bernoulli}; |
| <span class="kw">use </span>rusty_machine::linalg::{BaseMatrix, Matrix}; |
| |
| <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">1.1</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">3</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">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="kw">let </span><span class="kw-2">mut </span>model = NaiveBayes::<Bernoulli>::new(); |
| |
| <span class="kw">let </span>accuracy_per_fold: Vec<f64> = k_fold_validate( |
| <span class="kw-2">&mut </span>model, |
| <span class="kw-2">&</span>inputs, |
| <span class="kw-2">&</span>targets, |
| <span class="number">3</span>, |
| <span class="comment">// Score each fold by the fraction of test samples where |
| // the model's prediction equals the target. |
| </span>row_accuracy |
| ).unwrap();</code></pre></div> |
| </div></details></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> |
