| <!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 criterion for the Generalized Linear Model."><meta name="keywords" content="rust, rustlang, rust-lang, Criterion"><title>Criterion in rusty_machine::learning::glm - 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.Link">Link</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.model_variance">model_variance</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.apply_link_func">apply_link_func</a></li><li><a href="#method.apply_link_inv">apply_link_inv</a></li><li><a href="#method.compute_working_weight">compute_working_weight</a></li><li><a href="#method.compute_y_bar">compute_y_bar</a></li><li><a href="#method.initialize_mu">initialize_mu</a></li><li><a href="#method.link_grad">link_grad</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::glm</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">glm</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/glm.rs.html#148-210">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.Link" class="associatedtype">Link</a>: <a class="trait" href="trait.LinkFunc.html" title="trait rusty_machine::learning::glm::LinkFunc">LinkFunc</a>; |
| |
| fn <a href="#tymethod.model_variance" class="fnname">model_variance</a>(&self, mu: <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>; |
| |
| fn <a href="#method.initialize_mu" class="fnname">initialize_mu</a>(&self, y: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.compute_working_weight" class="fnname">compute_working_weight</a>(&self, mu: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.compute_y_bar" class="fnname">compute_y_bar</a>(&self, y: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>], mu: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.apply_link_func" class="fnname">apply_link_func</a>(&self, vec: <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>) -> <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</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.apply_link_inv" class="fnname">apply_link_inv</a>(&self, vec: <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>) -> <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</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.link_grad" class="fnname">link_grad</a>(&self, mu: <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> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The criterion for the Generalized Linear Model.</p> |
| <p>This trait specifies a Link function and requires a model |
| variance to be specified. The model variance must be defined |
| to specify the regression family. The other functions need not |
| be specified but can be used to control optimization.</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.Link" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#150">source</a><h4 class="code-header">type <a href="#associatedtype.Link" class="associatedtype">Link</a>: <a class="trait" href="trait.LinkFunc.html" title="trait rusty_machine::learning::glm::LinkFunc">LinkFunc</a></h4></section></summary><div class="docblock"><p>The link function of the GLM Criterion.</p> |
| </div></details></div><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.model_variance" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#153">source</a><h4 class="code-header">fn <a href="#tymethod.model_variance" class="fnname">model_variance</a>(&self, mu: <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 variance of the regression family.</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.initialize_mu" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#158-160">source</a><h4 class="code-header">fn <a href="#method.initialize_mu" class="fnname">initialize_mu</a>(&self, y: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>Initializes the mean value.</p> |
| <p>By default the mean takes the training target values.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.compute_working_weight" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#169-178">source</a><h4 class="code-header">fn <a href="#method.compute_working_weight" class="fnname">compute_working_weight</a>(&self, mu: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>Computes the working weights that make up the diagonal |
| of the <code>W</code> matrix used in the iterative reweighted least squares |
| algorithm.</p> |
| <p>This is equal to:</p> |
| <p>1 / (Var(u) * g’(u) * g’(u))</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.compute_y_bar" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#186-194">source</a><h4 class="code-header">fn <a href="#method.compute_y_bar" class="fnname">compute_y_bar</a>(&self, y: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>], mu: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]) -> <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>Computes the adjustment to the fitted values used during |
| fitting.</p> |
| <p>This is equal to:</p> |
| <p>g`(u) * (y - u)</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.apply_link_func" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#197-199">source</a><h4 class="code-header">fn <a href="#method.apply_link_func" class="fnname">apply_link_func</a>(&self, vec: <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>) -> <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>></h4></section></summary><div class="docblock"><p>Applies the link function to a vector.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.apply_link_inv" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#202-204">source</a><h4 class="code-header">fn <a href="#method.apply_link_inv" class="fnname">apply_link_inv</a>(&self, vec: <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>) -> <a class="struct" href="../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>></h4></section></summary><div class="docblock"><p>Applies the inverse of the link function to a vector.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.link_grad" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#207-209">source</a><h4 class="code-header">fn <a href="#method.link_grad" class="fnname">link_grad</a>(&self, mu: <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>Computes the gradient of the link function.</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-Bernoulli" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#302-362">source</a><a href="#impl-Criterion-for-Bernoulli" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::glm::Criterion">Criterion</a> for <a class="struct" href="struct.Bernoulli.html" title="struct rusty_machine::learning::glm::Bernoulli">Bernoulli</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Link-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Link-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Link" class="associatedtype">Link</a> = <a class="struct" href="struct.Logit.html" title="struct rusty_machine::learning::glm::Logit">Logit</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Criterion-for-Binomial" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#370-431">source</a><a href="#impl-Criterion-for-Binomial" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::glm::Criterion">Criterion</a> for <a class="struct" href="struct.Binomial.html" title="struct rusty_machine::learning::glm::Binomial">Binomial</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Link-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Link-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Link" class="associatedtype">Link</a> = <a class="struct" href="struct.Logit.html" title="struct rusty_machine::learning::glm::Logit">Logit</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Criterion-for-Normal" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#439-445">source</a><a href="#impl-Criterion-for-Normal" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::glm::Criterion">Criterion</a> for <a class="struct" href="struct.Normal.html" title="struct rusty_machine::learning::glm::Normal">Normal</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Link-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Link-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Link" class="associatedtype">Link</a> = <a class="struct" href="struct.Identity.html" title="struct rusty_machine::learning::glm::Identity">Identity</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Criterion-for-Poisson" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/glm.rs.html#451-475">source</a><a href="#impl-Criterion-for-Poisson" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Criterion.html" title="trait rusty_machine::learning::glm::Criterion">Criterion</a> for <a class="struct" href="struct.Poisson.html" title="struct rusty_machine::learning::glm::Poisson">Poisson</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Link-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Link-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Link" class="associatedtype">Link</a> = <a class="struct" href="struct.Log.html" title="struct rusty_machine::learning::glm::Log">Log</a></h4></section></div></details></div><script src="../../../implementors/rusty_machine/learning/glm/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> |
