| <!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="Trait for optimization algorithms."><meta name="keywords" content="rust, rustlang, rust-lang, OptimAlgorithm"><title>OptimAlgorithm in rusty_machine::learning::optim - 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 trait"><!--[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="#">OptimAlgorithm</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.optimize">optimize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::optim</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">Trait <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">learning</a>::<wbr><a href="index.html">optim</a>::<wbr><a class="trait" href="#">OptimAlgorithm</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/lib.rs.html#190-200">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 trait"><code>pub trait OptimAlgorithm<M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a>> { |
| fn <a href="#tymethod.optimize" class="fnname">optimize</a>(<br> &self,<br> model: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>M,<br> start: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>],<br> inputs: &M::<a class="associatedtype" href="trait.Optimizable.html#associatedtype.Inputs" title="type rusty_machine::learning::optim::Optimizable::Inputs">Inputs</a>,<br> targets: &M::<a class="associatedtype" href="trait.Optimizable.html#associatedtype.Targets" title="type rusty_machine::learning::optim::Optimizable::Targets">Targets</a><br> ) -> <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>>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for optimization algorithms.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.optimize" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/lib.rs.html#194-199">source</a><h4 class="code-header">fn <a href="#tymethod.optimize" class="fnname">optimize</a>(<br> &self,<br> model: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>M,<br> start: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>],<br> inputs: &M::<a class="associatedtype" href="trait.Optimizable.html#associatedtype.Inputs" title="type rusty_machine::learning::optim::Optimizable::Inputs">Inputs</a>,<br> targets: &M::<a class="associatedtype" href="trait.Optimizable.html#associatedtype.Targets" title="type rusty_machine::learning::optim::Optimizable::Targets">Targets</a><br>) -> <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>></h4></section></summary><div class="docblock"><p>Return the optimized parameter using gradient optimization.</p> |
| <p>Takes in a set of starting parameters and related model data.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-OptimAlgorithm%3CM%3E-for-RMSProp" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/optim/grad_desc.rs.html#371-422">source</a><a href="#impl-OptimAlgorithm%3CM%3E-for-RMSProp" class="anchor"></a><h3 class="code-header">impl<M> <a class="trait" href="trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><M> for <a class="struct" href="grad_desc/struct.RMSProp.html" title="struct rusty_machine::learning::optim::grad_desc::RMSProp">RMSProp</a><span class="where fmt-newline">where<br> M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a><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>>, 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>>>,</span></h3></section><section id="impl-OptimAlgorithm%3CM%3E-for-StochasticGD" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/optim/grad_desc.rs.html#156-210">source</a><a href="#impl-OptimAlgorithm%3CM%3E-for-StochasticGD" class="anchor"></a><h3 class="code-header">impl<M> <a class="trait" href="trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><M> for <a class="struct" href="grad_desc/struct.StochasticGD.html" title="struct rusty_machine::learning::optim::grad_desc::StochasticGD">StochasticGD</a><span class="where fmt-newline">where<br> M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a><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>>, 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>>>,</span></h3></section><section id="impl-OptimAlgorithm%3CM%3E-for-ConjugateGD" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/optim/fmincg.rs.html#83-272">source</a><a href="#impl-OptimAlgorithm%3CM%3E-for-ConjugateGD" class="anchor"></a><h3 class="code-header">impl<M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a>> <a class="trait" href="trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><M> for <a class="struct" href="fmincg/struct.ConjugateGD.html" title="struct rusty_machine::learning::optim::fmincg::ConjugateGD">ConjugateGD</a></h3></section><section id="impl-OptimAlgorithm%3CM%3E-for-GradientDesc" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/optim/grad_desc.rs.html#68-97">source</a><a href="#impl-OptimAlgorithm%3CM%3E-for-GradientDesc" class="anchor"></a><h3 class="code-header">impl<M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a>> <a class="trait" href="trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><M> for <a class="struct" href="grad_desc/struct.GradientDesc.html" title="struct rusty_machine::learning::optim::grad_desc::GradientDesc">GradientDesc</a></h3></section><section id="impl-OptimAlgorithm%3CM%3E-for-AdaGrad" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/optim/grad_desc.rs.html#257-309">source</a><a href="#impl-OptimAlgorithm%3CM%3E-for-AdaGrad" class="anchor"></a><h3 class="code-header">impl<M: <a class="trait" href="trait.Optimizable.html" title="trait rusty_machine::learning::optim::Optimizable">Optimizable</a><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>>, 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>>>> <a class="trait" href="trait.OptimAlgorithm.html" title="trait rusty_machine::learning::optim::OptimAlgorithm">OptimAlgorithm</a><M> for <a class="struct" href="grad_desc/struct.AdaGrad.html" title="struct rusty_machine::learning::optim::grad_desc::AdaGrad">AdaGrad</a></h3></section></div><script src="../../../implementors/rusty_machine/learning/optim/trait.OptimAlgorithm.js" async></script></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> |
