Diffusers.jl/dev/schedulers/index.html
2023-10-06 17:50:51 +00:00

3 lines
10 KiB
HTML

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Schedulers · 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><span class="tocitem">API</span><ul><li class="is-active"><a class="tocitem" href>Schedulers</a></li><li><a class="tocitem" href="../beta_schedules/">Beta Schedules</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../generated/beta_schedulers_comparison/">Beta Schedules Comparison</a></li></ul></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><a class="is-disabled">API</a></li><li class="is-active"><a href>Schedulers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Schedulers</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Laurent2916/Diffusers.jl/blob/master/docs/src/schedulers.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"><p><img src="https://ar5iv.org/html/2208.11970/assets/images/vdm_base.png" alt="Markovian Hierarchical Variational Autoencoder"/></p><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.DDIM" href="#Diffusers.Schedulers.DDIM"><code>Diffusers.Schedulers.DDIM</code></a><span class="docstring-category">Type</span></header><section><div><p>Denoising Diffusion Implicit Models (DDIM) scheduler.</p><p><strong>References</strong></p><ul><li><a href="https://arxiv.org/abs/2010.02502">[2010.02502] Denoising Diffusion Implicit Models</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/DDIM.jl#L14-L19">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.DDPM" href="#Diffusers.Schedulers.DDPM"><code>Diffusers.Schedulers.DDPM</code></a><span class="docstring-category">Type</span></header><section><div><p>Denoising Diffusion Probabilistic Models (DDPM) scheduler.</p><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/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/DDPM.jl#L14-L19">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.Scheduler" href="#Diffusers.Schedulers.Scheduler"><code>Diffusers.Schedulers.Scheduler</code></a><span class="docstring-category">Type</span></header><section><div><p>Abstract type for schedulers.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/Abstract.jl#L4-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.forward-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}" href="#Diffusers.Schedulers.forward-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}"><code>Diffusers.Schedulers.forward</code></a><span class="docstring-category">Method</span></header><section><div><p>Add noise to clean data using the forward diffusion process.</p><p><strong>Input</strong></p><ul><li><code>scheduler::Scheduler</code>: scheduler to use</li><li><code>x₀::AbstractArray</code>: clean data to add noise to</li><li><code>ϵ::AbstractArray</code>: noise to add to clean data</li><li><code>t::AbstractArray</code>: timesteps used to weight the noise</li></ul><p><strong>Output</strong></p><ul><li><code>xₜ::AbstractArray</code>: noisy data at the given timesteps</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/Abstract.jl#L10-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.get_velocity-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}" href="#Diffusers.Schedulers.get_velocity-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}"><code>Diffusers.Schedulers.get_velocity</code></a><span class="docstring-category">Method</span></header><section><div><p>Compute the velocity of the diffusion process.</p><p><strong>Input</strong></p><ul><li><code>scheduler::Scheduler</code>: scheduler to use</li><li><code>x₀::AbstractArray</code>: clean data to add noise to</li><li><code>ϵ::AbstractArray</code>: noise to add to clean data</li><li><code>t::AbstractArray</code>: timesteps used to weight the noise</li></ul><p><strong>Output</strong></p><ul><li><code>vₜ::AbstractArray</code>: velocity at the given timesteps</li></ul><p><strong>References</strong></p><p><a href="../references/#salimans2022progressive">[1, Ann. D]</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/Abstract.jl#L49-L63">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Diffusers.Schedulers.reverse-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}" href="#Diffusers.Schedulers.reverse-Tuple{Diffusers.Schedulers.Scheduler, AbstractArray, AbstractArray, AbstractArray}"><code>Diffusers.Schedulers.reverse</code></a><span class="docstring-category">Method</span></header><section><div><p>Remove noise from model output using the backward diffusion process.</p><p><strong>Input</strong></p><ul><li><code>scheduler::Scheduler</code>: scheduler to use</li><li><code>xₜ::AbstractArray</code>: sample to be denoised</li><li><code>ϵᵧ::AbstractArray</code>: predicted noise to remove</li><li><code>t::AbstractArray</code>: timestep t of <code>xₜ</code></li></ul><p><strong>Output</strong></p><ul><li><code>xₜ₋₁::AbstractArray</code>: denoised sample at t=t-1</li><li><code>x̂₀::AbstractArray</code>: denoised sample at t=0</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Laurent2916/Diffusers.jl/blob/1a317e470372442791625722f64b30b5e3d9e28f/src/Schedulers/Abstract.jl#L29-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../beta_schedules/">Beta Schedules »</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="Friday 6 October 2023 17:50">Friday 6 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>