| <!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="Criterion for Neural Networks"><meta name="keywords" content="rust, rustlang, rust-lang, Criterion"><title>Criterion in rusty_machine::learning::nnet - 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="#">Criterion</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Cost">Cost</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.cost">cost</a></li><li><a href="#method.cost_grad">cost_grad</a></li><li><a href="#method.is_regularized">is_regularized</a></li><li><a href="#method.reg_cost">reg_cost</a></li><li><a href="#method.reg_cost_grad">reg_cost_grad</a></li><li><a href="#method.regularization">regularization</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::nnet</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">nnet</a>::<wbr><a class="trait" href="#">Criterion</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/learning/nnet/mod.rs.html#452-506">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 Criterion { |
| type <a href="#associatedtype.Cost" class="associatedtype">Cost</a>: <a class="trait" href="../toolkit/cost_fn/trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</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>>>; |
| |
| fn <a href="#method.cost" class="fnname">cost</a>(&self, outputs: &<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.cost_grad" class="fnname">cost_grad</a>(<br> &self,<br> outputs: &<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> ) -> <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 class="item-spacer"></span> fn <a href="#method.regularization" class="fnname">regularization</a>(&self) -> <a class="enum" href="../toolkit/regularization/enum.Regularization.html" title="enum rusty_machine::learning::toolkit::regularization::Regularization">Regularization</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.is_regularized" class="fnname">is_regularized</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.reg_cost" class="fnname">reg_cost</a>(&self, reg_weights: <a class="struct" href="../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</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> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.reg_cost_grad" class="fnname">reg_cost_grad</a>(&self, reg_weights: <a class="struct" href="../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</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>> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Criterion for Neural Networks</p> |
| <p>Specifies an activation function and a cost function.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Cost" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#454">source</a><h4 class="code-header">type <a href="#associatedtype.Cost" class="associatedtype">Cost</a>: <a class="trait" href="../toolkit/cost_fn/trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</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>>></h4></section></summary><div class="docblock"><p>The cost function for the criterion.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cost" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#459-461">source</a><h4 class="code-header">fn <a href="#method.cost" class="fnname">cost</a>(&self, outputs: &<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>The cost function.</p> |
| <p>Returns a scalar cost.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cost_grad" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#466-468">source</a><h4 class="code-header">fn <a href="#method.cost_grad" class="fnname">cost_grad</a>(&self, outputs: &<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="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>></h4></section></summary><div class="docblock"><p>The gradient of the cost function.</p> |
| <p>Returns a matrix of cost gradients.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.regularization" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#473-475">source</a><h4 class="code-header">fn <a href="#method.regularization" class="fnname">regularization</a>(&self) -> <a class="enum" href="../toolkit/regularization/enum.Regularization.html" title="enum rusty_machine::learning::toolkit::regularization::Regularization">Regularization</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>></h4></section></summary><div class="docblock"><p>Returns the regularization for this criterion.</p> |
| <p>Will return <code>Regularization::None</code> by default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_regularized" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#480-485">source</a><h4 class="code-header">fn <a href="#method.is_regularized" class="fnname">is_regularized</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if the current criterion includes regularization.</p> |
| <p>Will return <code>false</code> by default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reg_cost" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#493-495">source</a><h4 class="code-header">fn <a href="#method.reg_cost" class="fnname">reg_cost</a>(&self, reg_weights: <a class="struct" href="../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</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></h4></section></summary><div class="docblock"><p>Returns the regularization cost for the criterion.</p> |
| <p>Will return <code>0</code> by default.</p> |
| <p>This method will not be invoked by the neural network |
| if there is explicitly no regularization.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reg_cost_grad" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#503-505">source</a><h4 class="code-header">fn <a href="#method.reg_cost_grad" class="fnname">reg_cost_grad</a>(&self, reg_weights: <a class="struct" href="../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</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>></h4></section></summary><div class="docblock"><p>Returns the regularization gradient for the criterion.</p> |
| <p>Will return a matrix of zeros by default.</p> |
| <p>This method will not be invoked by the neural network |
| if there is explicitly no regularization.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Criterion-for-BCECriterion" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#517-523">source</a><a href="#impl-Criterion-for-BCECriterion" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::nnet::Criterion">Criterion</a> for <a class="struct" href="struct.BCECriterion.html" title="struct rusty_machine::learning::nnet::BCECriterion">BCECriterion</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Cost-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Cost-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Cost" class="associatedtype">Cost</a> = <a class="struct" href="../toolkit/cost_fn/struct.CrossEntropyError.html" title="struct rusty_machine::learning::toolkit::cost_fn::CrossEntropyError">CrossEntropyError</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Criterion-for-MSECriterion" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/nnet/mod.rs.html#558-564">source</a><a href="#impl-Criterion-for-MSECriterion" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::nnet::Criterion">Criterion</a> for <a class="struct" href="struct.MSECriterion.html" title="struct rusty_machine::learning::nnet::MSECriterion">MSECriterion</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Cost-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Cost-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Cost" class="associatedtype">Cost</a> = <a class="struct" href="../toolkit/cost_fn/struct.MeanSqError.html" title="struct rusty_machine::learning::toolkit::cost_fn::MeanSqError">MeanSqError</a></h4></section></div></details></div><script src="../../../implementors/rusty_machine/learning/nnet/trait.Criterion.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> |
