Diffusers.jl/dev/beta_schedules/index.html

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Beta Schedules · Diffusers.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Diffusers.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../schedulers/">Schedulers</a></li><li class="is-active"><a class="tocitem" href>Beta Schedules</a></li><li><a class="tocitem" href="../references/">References</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Beta Schedules</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Beta Schedules</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Laurent2916/Diffusers.jl/blob/master/docs/src/beta_schedules.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><object type="text/html" data="beta_schedules.html" style="width:100%;height:420px;"></object>
<object type="text/html" data="alpha_bar_schedules.html" style="width:100%;height:420px;"></object><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.cosine_beta_schedule" href="#Diffusers.BetaSchedules.cosine_beta_schedule"><code>Diffusers.BetaSchedules.cosine_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Cosine beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>βₘₐₓ::Real=0.999f0</code>: maximum value of β</li><li><code>ϵ::Real=1.0f-3</code>: small value used to avoid division by zero</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2102.09672">[2102.09672] Improved Denoising Diffusion Probabilistic Models</a></li><li><a href="https://github.com/openai/improved-diffusion/blob/783b6740edb79fdb7d063250db2c51cc9545dcd1/improved_diffusion/gaussian_diffusion.py#L36">github:openai/improved-diffusion</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Cosine.jl#L1-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.exponential_beta_schedule" href="#Diffusers.BetaSchedules.exponential_beta_schedule"><code>Diffusers.BetaSchedules.exponential_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Exponential beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>βₘₐₓ::Real=0.999f0</code>: maximum value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Exponential.jl#L1-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.linear_beta_schedule" href="#Diffusers.BetaSchedules.linear_beta_schedule"><code>Diffusers.BetaSchedules.linear_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Linear beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Integer</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial (t=1) value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final (t=T) value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2006.11239">[2006.11239] Denoising Diffusion Probabilistic Models</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Linear.jl#L1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.rescale_zero_terminal_snr-Tuple{AbstractArray}" href="#Diffusers.BetaSchedules.rescale_zero_terminal_snr-Tuple{AbstractArray}"><code>Diffusers.BetaSchedules.rescale_zero_terminal_snr</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Rescale betas to have zero terminal Signal to Noise Ratio (SNR).</p><p><strong>Input</strong></p><ul><li><code>β::AbstractArray</code>: βₜ values at each timestep t</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: rescaled βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2305.08891">[2305.08891] Rescaling Diffusion Models</a> (Alg. 1)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/ZeroSNR.jl#L1-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.scaled_linear_beta_schedule" href="#Diffusers.BetaSchedules.scaled_linear_beta_schedule"><code>Diffusers.BetaSchedules.scaled_linear_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Scaled linear beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2006.11239">[2006.11239] Denoising Diffusion Probabilistic Models</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/ScaledLinear.jl#L1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.sigmoid_beta_schedule" href="#Diffusers.BetaSchedules.sigmoid_beta_schedule"><code>Diffusers.BetaSchedules.sigmoid_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Sigmoid beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2203.02923">[2203.02923] GeoDiff: a Geometric Diffusion Model for Molecular Conformation Generation</a></li><li><a href="https://github.com/MinkaiXu/GeoDiff/blob/ea0ca48045a2f7abfccd7f0df449e45eb6eae638/models/epsnet/diffusion.py#L57">github.com:MinkaiXu/GeoDiff</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Sigmoid.jl#L3-L17">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../schedulers/">« Schedulers</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="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 0.27.25 on <span class="colophon-date" title="Saturday 9 September 2023 14:00">Saturday 9 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
	`<!DOCTYPE html>`
	<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Beta Schedules · Diffusers.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Diffusers.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../schedulers/">Schedulers</a></li><li class="is-active"><a class="tocitem" href>Beta Schedules</a></li><li><a class="tocitem" href="../references/">References</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Beta Schedules</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Beta Schedules</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Laurent2916/Diffusers.jl/blob/master/docs/src/beta_schedules.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><object type="text/html" data="beta_schedules.html" style="width:100%;height:420px;"></object>
	<object type="text/html" data="alpha_bar_schedules.html" style="width:100%;height:420px;"></object><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.cosine_beta_schedule" href="#Diffusers.BetaSchedules.cosine_beta_schedule"><code>Diffusers.BetaSchedules.cosine_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Cosine beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>βₘₐₓ::Real=0.999f0</code>: maximum value of β</li><li><code>ϵ::Real=1.0f-3</code>: small value used to avoid division by zero</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2102.09672">[2102.09672] Improved Denoising Diffusion Probabilistic Models</a></li><li><a href="https://github.com/openai/improved-diffusion/blob/783b6740edb79fdb7d063250db2c51cc9545dcd1/improved_diffusion/gaussian_diffusion.py#L36">github:openai/improved-diffusion</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Cosine.jl#L1-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.exponential_beta_schedule" href="#Diffusers.BetaSchedules.exponential_beta_schedule"><code>Diffusers.BetaSchedules.exponential_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Exponential beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>βₘₐₓ::Real=0.999f0</code>: maximum value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Exponential.jl#L1-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.linear_beta_schedule" href="#Diffusers.BetaSchedules.linear_beta_schedule"><code>Diffusers.BetaSchedules.linear_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Linear beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Integer</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial (t=1) value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final (t=T) value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2006.11239">[2006.11239] Denoising Diffusion Probabilistic Models</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Linear.jl#L1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.rescale_zero_terminal_snr-Tuple{AbstractArray}" href="#Diffusers.BetaSchedules.rescale_zero_terminal_snr-Tuple{AbstractArray}"><code>Diffusers.BetaSchedules.rescale_zero_terminal_snr</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Rescale betas to have zero terminal Signal to Noise Ratio (SNR).</p><p><strong>Input</strong></p><ul><li><code>β::AbstractArray</code>: βₜ values at each timestep t</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: rescaled βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2305.08891">[2305.08891] Rescaling Diffusion Models</a> (Alg. 1)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/ZeroSNR.jl#L1-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.scaled_linear_beta_schedule" href="#Diffusers.BetaSchedules.scaled_linear_beta_schedule"><code>Diffusers.BetaSchedules.scaled_linear_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Scaled linear beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2006.11239">[2006.11239] Denoising Diffusion Probabilistic Models</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/ScaledLinear.jl#L1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.BetaSchedules.sigmoid_beta_schedule" href="#Diffusers.BetaSchedules.sigmoid_beta_schedule"><code>Diffusers.BetaSchedules.sigmoid_beta_schedule</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Sigmoid beta schedule.</p><p><strong>Input</strong></p><ul><li><code>T::Int</code>: number of timesteps</li><li><code>β₁::Real=1.0f-4</code>: initial value of β</li><li><code>β₋₁::Real=2.0f-2</code>: final value of β</li></ul><p><strong>Output</strong></p><ul><li><code>β::Vector{Real}</code>: βₜ values at each timestep t</li></ul><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2203.02923">[2203.02923] GeoDiff: a Geometric Diffusion Model for Molecular Conformation Generation</a></li><li><a href="https://github.com/MinkaiXu/GeoDiff/blob/ea0ca48045a2f7abfccd7f0df449e45eb6eae638/models/epsnet/diffusion.py#L57">github.com:MinkaiXu/GeoDiff</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/0780fef33586f63c85405e398f5544c1b29ccff0/src/BetaSchedules/Sigmoid.jl#L3-L17">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../schedulers/">« Schedulers</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="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 0.27.25 on <span class="colophon-date" title="Saturday 9 September 2023 14:00">Saturday 9 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>