| <!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="Cache the sort results and some calculation results"><meta name="keywords" content="rust, rustlang, rust-lang, TrainingCache"><title>TrainingCache in gbdt::decision_tree - 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 struct"><!--[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="../../gbdt/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="../../gbdt/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">TrainingCache</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.get_cache">get_cache</a></li><li><a href="#method.get_preds">get_preds</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-TrainingCache">RefUnwindSafe</a></li><li><a href="#impl-Send-for-TrainingCache">Send</a></li><li><a href="#impl-Sync-for-TrainingCache">Sync</a></li><li><a href="#impl-Unpin-for-TrainingCache">Unpin</a></li><li><a href="#impl-UnwindSafe-for-TrainingCache">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-TrainingCache">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-TrainingCache">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-TrainingCache">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-TrainingCache">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-TrainingCache">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-TrainingCache">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-TrainingCache">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-TrainingCache">VZip<V></a></li></ul></section><h2><a href="index.html">In gbdt::decision_tree</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">Struct <a href="../index.html">gbdt</a>::<wbr><a href="index.html">decision_tree</a>::<wbr><a class="struct" href="#">TrainingCache</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/gbdt/decision_tree.rs.html#270-295">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 struct"><code>pub struct TrainingCache { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cache the sort results and some calculation results</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TrainingCache" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/decision_tree.rs.html#298-597">source</a><a href="#impl-TrainingCache" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_cache" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/decision_tree.rs.html#330-370">source</a><h4 class="code-header">pub fn <a href="#method.get_cache" class="fnname">get_cache</a>(feature_size: usize, data: &<a class="type" href="type.DataVec.html" title="type gbdt::decision_tree::DataVec">DataVec</a>, cache_level: u8) -> Self</h4></section></summary><div class="docblock"><p>Allocate the training cache. Feature size, training set and cache level should be provided.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::config::Loss; |
| <span class="kw">use </span>gbdt::decision_tree::{Data, DecisionTree, TrainingCache}; |
| <span class="comment">// set up training data |
| </span><span class="kw">let </span>data1 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>], |
| <span class="number">1.0</span>, |
| <span class="number">2.0</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span>data2 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">1.1</span>, <span class="number">2.1</span>, <span class="number">3.1</span>], |
| <span class="number">1.0</span>, |
| <span class="number">1.0</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span>data3 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">2.0</span>, <span class="number">2.0</span>, <span class="number">1.0</span>], |
| <span class="number">1.0</span>, |
| <span class="number">0.5</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>dv = Vec::new(); |
| dv.push(data1); |
| dv.push(data2); |
| dv.push(data3); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>cache = TrainingCache::get_cache(<span class="number">3</span>, <span class="kw-2">&</span>dv, <span class="number">2</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_preds" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/decision_tree.rs.html#425-427">source</a><h4 class="code-header">pub fn <a href="#method.get_preds" class="fnname">get_preds</a>(&self) -> Vec<<a class="type" href="type.ValueType.html" title="type gbdt::decision_tree::ValueType">ValueType</a>></h4></section></summary><div class="docblock"><p>Return the training data’s predictions using this decision tree. These results are computed during training and then cached.</p> |
| <h5 id="example"><a href="#example">Example</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::config::Loss; |
| <span class="kw">use </span>gbdt::decision_tree::{Data, DecisionTree, TrainingCache}; |
| <span class="comment">// set up training data |
| </span><span class="kw">let </span>data1 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>], |
| <span class="number">1.0</span>, |
| <span class="number">2.0</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span>data2 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">1.1</span>, <span class="number">2.1</span>, <span class="number">3.1</span>], |
| <span class="number">1.0</span>, |
| <span class="number">1.0</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span>data3 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">2.0</span>, <span class="number">2.0</span>, <span class="number">1.0</span>], |
| <span class="number">1.0</span>, |
| <span class="number">0.5</span>, |
| <span class="prelude-val">None |
| </span>); |
| <span class="kw">let </span>data4 = Data::new_training_data( |
| <span class="macro">vec!</span>[<span class="number">2.0</span>, <span class="number">2.3</span>, <span class="number">1.2</span>], |
| <span class="number">1.0</span>, |
| <span class="number">3.0</span>, |
| <span class="prelude-val">None |
| </span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>dv = Vec::new(); |
| dv.push(data1); |
| dv.push(data2); |
| dv.push(data3); |
| dv.push(data4); |
| |
| |
| <span class="comment">// train a decision tree |
| </span><span class="kw">let </span><span class="kw-2">mut </span>tree = DecisionTree::new(); |
| tree.set_feature_size(<span class="number">3</span>); |
| tree.set_max_depth(<span class="number">2</span>); |
| tree.set_min_leaf_size(<span class="number">1</span>); |
| tree.set_loss(Loss::SquaredError); |
| <span class="kw">let </span><span class="kw-2">mut </span>cache = TrainingCache::get_cache(<span class="number">3</span>, <span class="kw-2">&</span>dv, <span class="number">2</span>); |
| tree.fit(<span class="kw-2">&</span>dv, <span class="kw-2">&mut </span>cache); |
| <span class="comment">// get predictions for the training data |
| </span><span class="macro">println!</span>(<span class="string">"{:?}"</span>, cache.get_preds()); |
| |
| |
| <span class="comment">// output: |
| // [2.0, 0.75, 0.75, 3.0]</span></code></pre></div> |
| </div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-TrainingCache" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section><section id="impl-Send-for-TrainingCache" class="impl has-srclink"><a href="#impl-Send-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section><section id="impl-Sync-for-TrainingCache" class="impl has-srclink"><a href="#impl-Sync-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section><section id="impl-Unpin-for-TrainingCache" class="impl has-srclink"><a href="#impl-Unpin-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section><section id="impl-UnwindSafe-for-TrainingCache" class="impl has-srclink"><a href="#impl-UnwindSafe-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.TrainingCache.html" title="struct gbdt::decision_tree::TrainingCache">TrainingCache</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-TrainingCache" class="impl has-srclink"><a href="#impl-Any-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-TrainingCache" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-TrainingCache" class="impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-TrainingCache" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -> V</h4></section></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="gbdt" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
