build based on 865544c

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-11T17:00:57","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-12T10:37:45","documenter_version":"1.3.0"}}

dev/explanation/finite_sample_correction/index.html

@@ -15,4 +15,4 @@
     vline!([mean(Δ)], color=:red, label="mean")
     push!(plts, plt)
 end
-plot(plts..., layout=(1,3), size=(900, 300), legend=:topleft, title=[&quot;nobs = 100&quot; &quot;nobs = 1000&quot; &quot;nobs = 10000&quot;])</code></pre><p><img src="../finite_sample_correction_files/figure-commonmark/cell-3-output-1.svg" alt/></p><p>See also this related <a href="https://github.com/JuliaTrustworthyAI/ConformalPrediction.jl/discussions/17">discussion</a>.</p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Angelopoulos, Anastasios N., and Stephen Bates. 2021. “A Gentle Introduction to Conformal Prediction and Distribution-Free Uncertainty Quantification.” <a href="https://arxiv.org/abs/2107.07511">https://arxiv.org/abs/2107.07511</a>.</p><p>Barber, Rina Foygel, Emmanuel J. Candès, Aaditya Ramdas, and Ryan J. Tibshirani. 2021. “Predictive Inference with the Jackknife+.” <em>The Annals of Statistics</em> 49 (1): 486–507. <a href="https://doi.org/10.1214/20-AOS1965">https://doi.org/10.1214/20-AOS1965</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../architecture/">« Package Architecture</a><a class="docs-footer-nextpage" href="../../reference/">🧐 Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 11 March 2024 17:00">Monday 11 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+plot(plts..., layout=(1,3), size=(900, 300), legend=:topleft, title=[&quot;nobs = 100&quot; &quot;nobs = 1000&quot; &quot;nobs = 10000&quot;])</code></pre><p><img src="../finite_sample_correction_files/figure-commonmark/cell-3-output-1.svg" alt/></p><p>See also this related <a href="https://github.com/JuliaTrustworthyAI/ConformalPrediction.jl/discussions/17">discussion</a>.</p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Angelopoulos, Anastasios N., and Stephen Bates. 2021. “A Gentle Introduction to Conformal Prediction and Distribution-Free Uncertainty Quantification.” <a href="https://arxiv.org/abs/2107.07511">https://arxiv.org/abs/2107.07511</a>.</p><p>Barber, Rina Foygel, Emmanuel J. Candès, Aaditya Ramdas, and Ryan J. Tibshirani. 2021. “Predictive Inference with the Jackknife+.” <em>The Annals of Statistics</em> 49 (1): 486–507. <a href="https://doi.org/10.1214/20-AOS1965">https://doi.org/10.1214/20-AOS1965</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../architecture/">« Package Architecture</a><a class="docs-footer-nextpage" href="../../reference/">🧐 Reference »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 12 March 2024 10:37">Tuesday 12 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/explanation/index.html

@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Overview · ConformalPrediction.jl</title><meta name="title" content="Overview · ConformalPrediction.jl"/><meta property="og:title" content="Overview · ConformalPrediction.jl"/><meta property="twitter:title" content="Overview · ConformalPrediction.jl"/><meta name="description" content="Documentation for ConformalPrediction.jl."/><meta property="og:description" content="Documentation for ConformalPrediction.jl."/><meta property="twitter:description" content="Documentation for ConformalPrediction.jl."/><meta property="og:url" content="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="ConformalPrediction.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">ConformalPrediction.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">🏠 Home</a></li><li><span class="tocitem">🫣 Tutorials</span><ul><li><a class="tocitem" href="../tutorials/">Overview</a></li><li><a class="tocitem" href="../tutorials/classification/">Classification</a></li><li><a class="tocitem" href="../tutorials/regression/">Regression</a></li></ul></li><li><span class="tocitem">🫡 How-To Guides</span><ul><li><a class="tocitem" href="../how_to_guides/">Overview</a></li><li><a class="tocitem" href="../how_to_guides/mnist/">How to Conformalize a Deep Image Classifier</a></li><li><a class="tocitem" href="../how_to_guides/llm/">How to Conformalize a Large Language Model</a></li><li><a class="tocitem" href="../how_to_guides/timeseries/">How to Conformalize a Time Series Model</a></li></ul></li><li><span class="tocitem">🤓 Explanation</span><ul><li class="is-active"><a class="tocitem" href>Overview</a></li><li><a class="tocitem" href="architecture/">Package Architecture</a></li><li><a class="tocitem" href="finite_sample_correction/">Finite-sample Correction</a></li></ul></li><li><a class="tocitem" href="../reference/">🧐 Reference</a></li><li><a class="tocitem" href="../contribute/">🛠 Contribute</a></li><li><a class="tocitem" href="../faq/">❓ FAQ</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">🤓 Explanation</a></li><li class="is-active"><a href>Overview</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Overview</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/juliatrustworthyai/ConformalPrediction.jl/blob/main/docs/src/explanation/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Explanation"><a class="docs-heading-anchor" href="#Explanation">Explanation</a><a id="Explanation-1"></a><a class="docs-heading-anchor-permalink" href="#Explanation" title="Permalink"></a></h1><p>In this section you will find detailed explanations about the methodology and code.</p><blockquote><p>Explanation clarifies, deepens and broadens the reader’s understanding of a subject.</p><p>— <a href="https://diataxis.fr/explanation/">Diátaxis</a></p></blockquote><p>In other words, you come here because you are interested in understanding how all of this actually works 🤓</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../how_to_guides/timeseries/">« How to Conformalize a Time Series Model</a><a class="docs-footer-nextpage" href="architecture/">Package Architecture »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 11 March 2024 17:00">Monday 11 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Overview · ConformalPrediction.jl</title><meta name="title" content="Overview · ConformalPrediction.jl"/><meta property="og:title" content="Overview · ConformalPrediction.jl"/><meta property="twitter:title" content="Overview · ConformalPrediction.jl"/><meta name="description" content="Documentation for ConformalPrediction.jl."/><meta property="og:description" content="Documentation for ConformalPrediction.jl."/><meta property="twitter:description" content="Documentation for ConformalPrediction.jl."/><meta property="og:url" content="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/ConformalPrediction.jl/explanation/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="ConformalPrediction.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">ConformalPrediction.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">🏠 Home</a></li><li><span class="tocitem">🫣 Tutorials</span><ul><li><a class="tocitem" href="../tutorials/">Overview</a></li><li><a class="tocitem" href="../tutorials/classification/">Classification</a></li><li><a class="tocitem" href="../tutorials/regression/">Regression</a></li></ul></li><li><span class="tocitem">🫡 How-To Guides</span><ul><li><a class="tocitem" href="../how_to_guides/">Overview</a></li><li><a class="tocitem" href="../how_to_guides/mnist/">How to Conformalize a Deep Image Classifier</a></li><li><a class="tocitem" href="../how_to_guides/llm/">How to Conformalize a Large Language Model</a></li><li><a class="tocitem" href="../how_to_guides/timeseries/">How to Conformalize a Time Series Model</a></li></ul></li><li><span class="tocitem">🤓 Explanation</span><ul><li class="is-active"><a class="tocitem" href>Overview</a></li><li><a class="tocitem" href="architecture/">Package Architecture</a></li><li><a class="tocitem" href="finite_sample_correction/">Finite-sample Correction</a></li></ul></li><li><a class="tocitem" href="../reference/">🧐 Reference</a></li><li><a class="tocitem" href="../contribute/">🛠 Contribute</a></li><li><a class="tocitem" href="../faq/">❓ FAQ</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">🤓 Explanation</a></li><li class="is-active"><a href>Overview</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Overview</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/juliatrustworthyai/ConformalPrediction.jl/blob/main/docs/src/explanation/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Explanation"><a class="docs-heading-anchor" href="#Explanation">Explanation</a><a id="Explanation-1"></a><a class="docs-heading-anchor-permalink" href="#Explanation" title="Permalink"></a></h1><p>In this section you will find detailed explanations about the methodology and code.</p><blockquote><p>Explanation clarifies, deepens and broadens the reader’s understanding of a subject.</p><p>— <a href="https://diataxis.fr/explanation/">Diátaxis</a></p></blockquote><p>In other words, you come here because you are interested in understanding how all of this actually works 🤓</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../how_to_guides/timeseries/">« How to Conformalize a Time Series Model</a><a class="docs-footer-nextpage" href="architecture/">Package Architecture »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 12 March 2024 10:37">Tuesday 12 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>