| <!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="The Transforms module"><meta name="keywords" content="rust, rustlang, rust-lang, transforms"><title>rusty_machine::data::transforms - 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">☰</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 transforms</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</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">data</a>::<wbr><a class="mod" href="#">transforms</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/data/transforms/mod.rs.html#1-56">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Transforms module</p> |
| <p>This module contains traits used to transform data using common |
| techniques. It also reexports these <code>Transformer</code>s from child modules.</p> |
| <p>The <code>Transformer</code> trait provides a shared interface for all of the |
| data preprocessing transformations in rusty-machine. Some of these <code>Transformations</code> |
| can be inverted via the <code>Invertible</code> trait.</p> |
| <p>Note that some <code>Transformer</code>s can not be created without first using the |
| <code>TransformFitter</code> trait.</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::data::transforms::{Transformer, TransformFitter, MinMaxFitter}; |
| <span class="kw">use </span>rusty_machine::data::transforms::minmax::MinMaxScaler; |
| <span class="kw">use </span>rusty_machine::linalg::Matrix; |
| |
| <span class="comment">// Some data that we want to scale between 0 and 1 |
| </span><span class="kw">let </span>data = Matrix::new(<span class="number">3</span>, <span class="number">2</span>, <span class="macro">vec!</span>[-<span class="number">1.5</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.5</span>]); |
| <span class="comment">// Create a new `MinMaxScaler` using the `MinMaxFitter` |
| </span><span class="kw">let </span><span class="kw-2">mut </span>scaler: MinMaxScaler<f64> = MinMaxFitter::new(<span class="number">0.0</span>, <span class="number">1.0</span>).fit(<span class="kw-2">&</span>data).expect(<span class="string">"Failed to fit transformer"</span>); |
| <span class="comment">// Transform the data using the scaler |
| </span><span class="kw">let </span>transformed = scaler.transform(data).expect(<span class="string">"Failed to transformer data"</span>);</code></pre></div> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.MinMaxFitter"><code>pub use self::minmax::<a class="struct" href="minmax/struct.MinMaxFitter.html" title="struct rusty_machine::data::transforms::minmax::MinMaxFitter">MinMaxFitter</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Normalizer"><code>pub use self::normalize::<a class="struct" href="normalize/struct.Normalizer.html" title="struct rusty_machine::data::transforms::normalize::Normalizer">Normalizer</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Shuffler"><code>pub use self::shuffle::<a class="struct" href="shuffle/struct.Shuffler.html" title="struct rusty_machine::data::transforms::shuffle::Shuffler">Shuffler</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.StandardizerFitter"><code>pub use self::standardize::<a class="struct" href="standardize/struct.StandardizerFitter.html" title="struct rusty_machine::data::transforms::standardize::StandardizerFitter">StandardizerFitter</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="minmax/index.html" title="rusty_machine::data::transforms::minmax mod">minmax</a></div><div class="item-right docblock-short">The Min-Max transformer</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="normalize/index.html" title="rusty_machine::data::transforms::normalize mod">normalize</a></div><div class="item-right docblock-short">The Normalizing Transformer</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="shuffle/index.html" title="rusty_machine::data::transforms::shuffle mod">shuffle</a></div><div class="item-right docblock-short">The Shuffler</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="standardize/index.html" title="rusty_machine::data::transforms::standardize mod">standardize</a></div><div class="item-right docblock-short">The Standardizing Transformer</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.Invertible.html" title="rusty_machine::data::transforms::Invertible trait">Invertible</a></div><div class="item-right docblock-short">Trait for invertible data transformers</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TransformFitter.html" title="rusty_machine::data::transforms::TransformFitter trait">TransformFitter</a></div><div class="item-right docblock-short">A trait used to construct Transformers which must first be fitted</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Transformer.html" title="rusty_machine::data::transforms::Transformer trait">Transformer</a></div><div class="item-right docblock-short">Trait for data transformers</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> |
