build based on 9303105

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-18T22:37:56","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-19T18:47:56","documenter_version":"1.7.0"}}

dev/index.html

@@ -13,4 +13,4 @@
 Y_compressed = compress(poisson_epca, Y; maxiter=200, verbose=true)
 
 X_reconstructed = decompress(poisson_epca, X_compressed)
-Y_reconstructed = decompress(poisson_epca, Y_compressed)</code></pre><h2 id="Supported-Distributions"><a class="docs-heading-anchor" href="#Supported-Distributions">Supported Distributions</a><a id="Supported-Distributions-1"></a><a class="docs-heading-anchor-permalink" href="#Supported-Distributions" title="Permalink"></a></h2><table><tr><th style="text-align: right">Distribution</th><th style="text-align: right"><code>ExpFamilyPCA.jl</code></th><th style="text-align: right">Objective</th><th style="text-align: right">Link Function <span>$g(\theta)$</span></th></tr><tr><td style="text-align: right">Bernoulli</td><td style="text-align: right"><a href="constructors/bernoulli/"><code>BernoulliEPCA</code></a></td><td style="text-align: right"><span>$\log(1 + e^{\theta - 2x\theta})$</span></td><td style="text-align: right"><span>$\frac{e^\theta}{1 + e^\theta}$</span></td></tr><tr><td style="text-align: right">Binomial</td><td style="text-align: right"><a href="constructors/binomial/"><code>BinomialEPCA</code></a></td><td style="text-align: right"><span>$n \log(1 + e^\theta) - x\theta$</span></td><td style="text-align: right"><span>$\frac{ne^\theta}{1 + e^\theta}$</span></td></tr><tr><td style="text-align: right">Continuous Bernoulli</td><td style="text-align: right"><a href="constructors/continuous_bernoulli/"><code>ContinuousBernoulliEPCA</code></a></td><td style="text-align: right"><span>$\log\left(\frac{e^\theta - 1}{\theta}\right) - x\theta$</span></td><td style="text-align: right"><span>$\frac{\theta - 1}{\theta} + \frac{1}{e^\theta - 1}$</span></td></tr><tr><td style="text-align: right">Gamma¹</td><td style="text-align: right"><a href="constructors/gamma/"><code>GammaEPCA</code></a> or <a href="constructors/gamma/"><code>ItakuraSaitoEPCA</code></a></td><td style="text-align: right"><span>$-\log(-\theta) - x\theta$</span></td><td style="text-align: right"><span>$-\frac{1}{\theta}$</span></td></tr><tr><td style="text-align: right">Gaussian²</td><td style="text-align: right"><a href="constructors/gaussian/"><code>GaussianEPCA</code></a> or <a href="constructors/gaussian/"><code>NormalEPCA</code></a></td><td style="text-align: right"><span>$\frac{1}{2}(x - \theta)^2$</span></td><td style="text-align: right"><span>$\theta$</span></td></tr><tr><td style="text-align: right">Negative Binomial</td><td style="text-align: right"><a href="constructors/negative_binomial/"><code>NegativeBinomialEPCA</code></a></td><td style="text-align: right"><span>$-r \log(1 - e^\theta) - x\theta$</span></td><td style="text-align: right"><span>$\frac{-re^\theta}{e^\theta - 1}$</span></td></tr><tr><td style="text-align: right">Pareto</td><td style="text-align: right"><a href="constructors/pareto/"><code>ParetoEPCA</code></a></td><td style="text-align: right"><span>$-\log(-1 - \theta) + \theta \log m - x\theta$</span></td><td style="text-align: right"><span>$\log m - \frac{1}{\theta + 1}$</span></td></tr><tr><td style="text-align: right">Poisson³</td><td style="text-align: right"><a href="constructors/poisson/"><code>PoissonEPCA</code></a></td><td style="text-align: right"><span>$e^\theta - x\theta$</span></td><td style="text-align: right"><span>$e^\theta$</span></td></tr><tr><td style="text-align: right">Weibull</td><td style="text-align: right"><a href="constructors/weibull/"><code>WeibullEPCA</code></a></td><td style="text-align: right"><span>$-\log(-\theta) - x\theta$</span></td><td style="text-align: right"><span>$-\frac{1}{\theta}$</span></td></tr></table><p>¹: For the Gamma distribution, the link function is typically based on the inverse relationship.  </p><p>²: For Gaussian, also known as Normal distribution, the link function is the identity. </p><p>³: The Poisson distribution link function is exponential.</p><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><p>ExpFamilyPCA.jl was designed through the <a href="https://sisl.stanford.edu/">Stanford Intelligent Systems Laboratory (SISL)</a> which helps maintain open-source projects posted on the <a href="https://github.com/sisl">SISL organization repository</a> and the <a href="https://github.com/JuliaPOMDP">JuliaPOMDPs</a> community. We subscribe to the community&#39;s <a href="https://github.com/JuliaPOMDP/POMDPs.jl/blob/a14d1f3d2e1f551e154803064bc9496a0df4ba3e/CONTRIBUTING.md">contribution guidelines</a> and encourage new users with all levels of software development experience to contribute and ask questions. </p><p>If you would like to create a new compressor or improve an existing model, please open a new issue that briefly describes the contribution you would like to make and the problem that it fixes, if there is one.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="math/intro/">Introduction »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 18 November 2024 22:37">Monday 18 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Y_reconstructed = decompress(poisson_epca, Y_compressed)</code></pre><h2 id="Supported-Distributions"><a class="docs-heading-anchor" href="#Supported-Distributions">Supported Distributions</a><a id="Supported-Distributions-1"></a><a class="docs-heading-anchor-permalink" href="#Supported-Distributions" title="Permalink"></a></h2><table><tr><th style="text-align: right">Distribution</th><th style="text-align: right"><code>ExpFamilyPCA.jl</code></th><th style="text-align: right">Objective</th><th style="text-align: right">Link Function <span>$g(\theta)$</span></th></tr><tr><td style="text-align: right">Bernoulli</td><td style="text-align: right"><a href="constructors/bernoulli/"><code>BernoulliEPCA</code></a></td><td style="text-align: right"><span>$\log(1 + e^{\theta - 2x\theta})$</span></td><td style="text-align: right"><span>$\frac{e^\theta}{1 + e^\theta}$</span></td></tr><tr><td style="text-align: right">Binomial</td><td style="text-align: right"><a href="constructors/binomial/"><code>BinomialEPCA</code></a></td><td style="text-align: right"><span>$n \log(1 + e^\theta) - x\theta$</span></td><td style="text-align: right"><span>$\frac{ne^\theta}{1 + e^\theta}$</span></td></tr><tr><td style="text-align: right">Continuous Bernoulli</td><td style="text-align: right"><a href="constructors/continuous_bernoulli/"><code>ContinuousBernoulliEPCA</code></a></td><td style="text-align: right"><span>$\log\left(\frac{e^\theta - 1}{\theta}\right) - x\theta$</span></td><td style="text-align: right"><span>$\frac{\theta - 1}{\theta} + \frac{1}{e^\theta - 1}$</span></td></tr><tr><td style="text-align: right">Gamma¹</td><td style="text-align: right"><a href="constructors/gamma/"><code>GammaEPCA</code></a> or <a href="constructors/gamma/"><code>ItakuraSaitoEPCA</code></a></td><td style="text-align: right"><span>$-\log(-\theta) - x\theta$</span></td><td style="text-align: right"><span>$-\frac{1}{\theta}$</span></td></tr><tr><td style="text-align: right">Gaussian²</td><td style="text-align: right"><a href="constructors/gaussian/"><code>GaussianEPCA</code></a> or <a href="constructors/gaussian/"><code>NormalEPCA</code></a></td><td style="text-align: right"><span>$\frac{1}{2}(x - \theta)^2$</span></td><td style="text-align: right"><span>$\theta$</span></td></tr><tr><td style="text-align: right">Negative Binomial</td><td style="text-align: right"><a href="constructors/negative_binomial/"><code>NegativeBinomialEPCA</code></a></td><td style="text-align: right"><span>$-r \log(1 - e^\theta) - x\theta$</span></td><td style="text-align: right"><span>$\frac{-re^\theta}{e^\theta - 1}$</span></td></tr><tr><td style="text-align: right">Pareto</td><td style="text-align: right"><a href="constructors/pareto/"><code>ParetoEPCA</code></a></td><td style="text-align: right"><span>$-\log(-1 - \theta) + \theta \log m - x\theta$</span></td><td style="text-align: right"><span>$\log m - \frac{1}{\theta + 1}$</span></td></tr><tr><td style="text-align: right">Poisson³</td><td style="text-align: right"><a href="constructors/poisson/"><code>PoissonEPCA</code></a></td><td style="text-align: right"><span>$e^\theta - x\theta$</span></td><td style="text-align: right"><span>$e^\theta$</span></td></tr><tr><td style="text-align: right">Weibull</td><td style="text-align: right"><a href="constructors/weibull/"><code>WeibullEPCA</code></a></td><td style="text-align: right"><span>$-\log(-\theta) - x\theta$</span></td><td style="text-align: right"><span>$-\frac{1}{\theta}$</span></td></tr></table><p>¹: For the Gamma distribution, the link function is typically based on the inverse relationship.  </p><p>²: For Gaussian, also known as Normal distribution, the link function is the identity. </p><p>³: The Poisson distribution link function is exponential.</p><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><p>ExpFamilyPCA.jl was designed through the <a href="https://sisl.stanford.edu/">Stanford Intelligent Systems Laboratory (SISL)</a> which helps maintain open-source projects posted on the <a href="https://github.com/sisl">SISL organization repository</a> and the <a href="https://github.com/JuliaPOMDP">JuliaPOMDPs</a> community. We subscribe to the community&#39;s <a href="https://github.com/JuliaPOMDP/POMDPs.jl/blob/a14d1f3d2e1f551e154803064bc9496a0df4ba3e/CONTRIBUTING.md">contribution guidelines</a> and encourage new users with all levels of software development experience to contribute and ask questions. </p><p>If you would like to create a new compressor or improve an existing model, please open a new issue that briefly describes the contribution you would like to make and the problem that it fixes, if there is one.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="math/intro/">Introduction »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 19 November 2024 18:47">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/math/appendix/expectation/index.html

@@ -7,4 +7,4 @@
 &= \int x \exp(x \theta - G(\theta)) h(x) \, dx \\
 &= \int x p_\theta(x) \, dx \\
 &= \mathbb{E}_\theta[X].
-\end{aligned}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../inverses/">« Inverse Link Functions</a><a class="docs-footer-nextpage" href="../../references/">References »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 18 November 2024 22:37">Monday 18 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+\end{aligned}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../inverses/">« Inverse Link Functions</a><a class="docs-footer-nextpage" href="../../references/">References »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 19 November 2024 18:47">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/math/appendix/gamma/index.html

@@ -11,4 +11,4 @@
 &= \frac{p}{q} - \log \frac{p}{q} - 1,
 \end{aligned}\]</p><p>so <span>$B_F$</span> is the Itakura-Saito (<a href="../../references/#ItakuraSaito">Itakura and Saito, 1968</a>) distance as desired. Further, the EPCA objective is</p><p class="math-container">\[\begin{aligned}
 B_F(x \| g(\theta)) = \frac{p}{g(\theta)} - \log \frac{p}{g(\theta)} - 1 = -p\theta - \log(-p\theta) - 1.
-\end{aligned}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../objectives/">« EPCA Objectives</a><a class="docs-footer-nextpage" href="../poisson/">Poisson EPCA and Generalized KL-Divergence »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 18 November 2024 22:37">Monday 18 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+\end{aligned}\]</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../objectives/">« EPCA Objectives</a><a class="docs-footer-nextpage" href="../poisson/">Poisson EPCA and Generalized KL-Divergence »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 19 November 2024 18:47">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>