| <!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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rusty-machine/src/data/transforms/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../rusty_machine/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! The Transforms module |
| //! |
| //! This module contains traits used to transform data using common |
| //! techniques. It also reexports these `Transformer`s from child modules. |
| //! |
| //! The `Transformer` trait provides a shared interface for all of the |
| //! data preprocessing transformations in rusty-machine. Some of these `Transformations` |
| //! can be inverted via the `Invertible` trait. |
| //! |
| //! Note that some `Transformer`s can not be created without first using the |
| //! `TransformFitter` trait. |
| //! |
| //! # Examples |
| //! |
| //! ``` |
| //! use rusty_machine::data::transforms::{Transformer, TransformFitter, MinMaxFitter}; |
| //! use rusty_machine::data::transforms::minmax::MinMaxScaler; |
| //! use rusty_machine::linalg::Matrix; |
| //! |
| //! // Some data that we want to scale between 0 and 1 |
| //! let data = Matrix::new(3, 2, vec![-1.5, 1.0, 2.0, 3.0, -1.0, 2.5]); |
| //! // Create a new `MinMaxScaler` using the `MinMaxFitter` |
| //! let mut scaler: MinMaxScaler<f64> = MinMaxFitter::new(0.0, 1.0).fit(&data).expect("Failed to fit transformer"); |
| //! // Transform the data using the scaler |
| //! let transformed = scaler.transform(data).expect("Failed to transformer data"); |
| //! ``` |
| |
| </span><span class="kw">pub mod </span>minmax; |
| <span class="kw">pub mod </span>normalize; |
| <span class="kw">pub mod </span>standardize; |
| <span class="kw">pub mod </span>shuffle; |
| |
| <span class="kw">use </span>learning::LearningResult; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::minmax::MinMaxFitter; |
| <span class="kw">pub use </span><span class="self">self</span>::normalize::Normalizer; |
| <span class="kw">pub use </span><span class="self">self</span>::shuffle::Shuffler; |
| <span class="kw">pub use </span><span class="self">self</span>::standardize::StandardizerFitter; |
| |
| <span class="doccomment">/// A trait used to construct Transformers which must first be fitted |
| </span><span class="kw">pub trait </span>TransformFitter<U, T: Transformer<U>> { |
| <span class="doccomment">/// Fit the inputs to create the `Transformer` |
| </span><span class="kw">fn </span>fit(<span class="self">self</span>, inputs: <span class="kw-2">&</span>U) -> LearningResult<T>; |
| } |
| |
| <span class="doccomment">/// Trait for data transformers |
| </span><span class="kw">pub trait </span>Transformer<T> { |
| <span class="doccomment">/// Transforms the inputs |
| </span><span class="kw">fn </span>transform(<span class="kw-2">&mut </span><span class="self">self</span>, inputs: T) -> LearningResult<T>; |
| } |
| |
| <span class="doccomment">/// Trait for invertible data transformers |
| </span><span class="kw">pub trait </span>Invertible<T> : Transformer<T> { |
| <span class="doccomment">/// Maps the inputs using the inverse of the fitted transform. |
| </span><span class="kw">fn </span>inv_transform(<span class="kw-2">&</span><span class="self">self</span>, inputs: T) -> LearningResult<T>; |
| } |
| </code></pre></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> |
