build based on 68cf616

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-28T02:49:25","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-23T13:31:17","documenter_version":"1.4.1"}}

dev/api/general/index.html

@@ -8,5 +8,5 @@
 julia> opt = Scheduler(Momentum, CosAnneal(l0 = 0.1, l1 = 0.8, period = 10), Exp(0.999, 0.8));
 
 # schedule the weight decay term of AdamW with a custom fixed learning rate
-julia&gt; opt = Scheduler(AdamW, eta = 1e-4, decay = Exp(1e-3, 0.7));</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/scheduler.jl#L1-L35">source</a></section></article><h2 id="State-schedule-API-reference"><a class="docs-heading-anchor" href="#State-schedule-API-reference">State schedule API reference</a><a id="State-schedule-API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#State-schedule-API-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.Stateful" href="#ParameterSchedulers.Stateful"><code>ParameterSchedulers.Stateful</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Stateful{T, S}
-Stateful(schedule::T; advance = state -&gt; true)</code></pre><p>Create a stateful iterator around <code>schedule</code>. Pass in a predicate, <code>advance(state)</code>, to conditionally control iteration. See also <a href><code>ParameterSchedulers.next!</code></a> and <a href><code>ParameterSchedulers.reset!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/complex.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.next!" href="#ParameterSchedulers.next!"><code>ParameterSchedulers.next!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">next!(iter::Stateful)</code></pre><p>Advance <code>iter</code> by one iteration (if <code>iter.advance(state) == true</code>) and return the next value. See also <a href><code>ParameterSchedulers.Stateful</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/complex.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.reset!" href="#ParameterSchedulers.reset!"><code>ParameterSchedulers.reset!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reset!(iter::Stateful)</code></pre><p>Reset <code>iter</code> to its initial state. See also <a href><code>ParameterSchedulers.Stateful</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/complex.jl#L32-L37">source</a></section></article><h2 id="Utility-functions-API-reference"><a class="docs-heading-anchor" href="#Utility-functions-API-reference">Utility functions API reference</a><a id="Utility-functions-API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#Utility-functions-API-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.depkwargs-Tuple{Symbol, Any, Vararg{Pair}}" href="#ParameterSchedulers.depkwargs-Tuple{Symbol, Any, Vararg{Pair}}"><code>ParameterSchedulers.depkwargs</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">depkwargs(fn::Symbol, kwargs, remaps::Pair...)</code></pre><p>Remap depracated <code>kwargs</code> when calling <code>fn</code> according to each pair in <code>remaps</code>. Such <code>remaps</code> parameter provides the mapping between <code>old_param_name =&gt; new_param_name</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/utils.jl#L37-L42">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.reverse-Tuple{Any, Any}" href="#ParameterSchedulers.reverse-Tuple{Any, Any}"><code>ParameterSchedulers.reverse</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">reverse(f, period)</code></pre><p>Return a reverse function such that <code>reverse(f, period)(t) == f(period - t)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/utils.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.symmetric-Tuple{Any, Any}" href="#ParameterSchedulers.symmetric-Tuple{Any, Any}"><code>ParameterSchedulers.symmetric</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">symmetric(f, period)</code></pre><p>Return a symmetric function such that for <code>t ∈ [1, period / 2)</code>, the symmetric function evaluates to <code>f(t)</code>, and when <code>t ∈ [period / 2, period)</code>, the symmetric functions evaluates to <code>f(period - t)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/22742e1e3c955c783fb512ea4e92a1a2e2065443/src/utils.jl#L10-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../interface/">« Schedule interface</a><a class="docs-footer-nextpage" href="../decay/">Decay schedule API 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="Thursday 28 March 2024 02:49">Thursday 28 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; opt = Scheduler(AdamW, eta = 1e-4, decay = Exp(1e-3, 0.7));</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/scheduler.jl#L1-L35">source</a></section></article><h2 id="State-schedule-API-reference"><a class="docs-heading-anchor" href="#State-schedule-API-reference">State schedule API reference</a><a id="State-schedule-API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#State-schedule-API-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.Stateful" href="#ParameterSchedulers.Stateful"><code>ParameterSchedulers.Stateful</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Stateful{T, S}
+Stateful(schedule::T; advance = state -&gt; true)</code></pre><p>Create a stateful iterator around <code>schedule</code>. Pass in a predicate, <code>advance(state)</code>, to conditionally control iteration. See also <a href><code>ParameterSchedulers.next!</code></a> and <a href><code>ParameterSchedulers.reset!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/complex.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.next!" href="#ParameterSchedulers.next!"><code>ParameterSchedulers.next!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">next!(iter::Stateful)</code></pre><p>Advance <code>iter</code> by one iteration (if <code>iter.advance(state) == true</code>) and return the next value. See also <a href><code>ParameterSchedulers.Stateful</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/complex.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.reset!" href="#ParameterSchedulers.reset!"><code>ParameterSchedulers.reset!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reset!(iter::Stateful)</code></pre><p>Reset <code>iter</code> to its initial state. See also <a href><code>ParameterSchedulers.Stateful</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/complex.jl#L32-L37">source</a></section></article><h2 id="Utility-functions-API-reference"><a class="docs-heading-anchor" href="#Utility-functions-API-reference">Utility functions API reference</a><a id="Utility-functions-API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#Utility-functions-API-reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.depkwargs-Tuple{Symbol, Any, Vararg{Pair}}" href="#ParameterSchedulers.depkwargs-Tuple{Symbol, Any, Vararg{Pair}}"><code>ParameterSchedulers.depkwargs</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">depkwargs(fn::Symbol, kwargs, remaps::Pair...)</code></pre><p>Remap depracated <code>kwargs</code> when calling <code>fn</code> according to each pair in <code>remaps</code>. Such <code>remaps</code> parameter provides the mapping between <code>old_param_name =&gt; new_param_name</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/utils.jl#L37-L42">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.reverse-Tuple{Any, Any}" href="#ParameterSchedulers.reverse-Tuple{Any, Any}"><code>ParameterSchedulers.reverse</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">reverse(f, period)</code></pre><p>Return a reverse function such that <code>reverse(f, period)(t) == f(period - t)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/utils.jl#L3-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ParameterSchedulers.symmetric-Tuple{Any, Any}" href="#ParameterSchedulers.symmetric-Tuple{Any, Any}"><code>ParameterSchedulers.symmetric</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">symmetric(f, period)</code></pre><p>Return a symmetric function such that for <code>t ∈ [1, period / 2)</code>, the symmetric function evaluates to <code>f(t)</code>, and when <code>t ∈ [period / 2, period)</code>, the symmetric functions evaluates to <code>f(period - t)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/FluxML/ParameterSchedulers.jl/blob/68cf6166ea1fc7d43a1a6dd2b2a2f028c2a54997/src/utils.jl#L10-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../interface/">« Schedule interface</a><a class="docs-footer-nextpage" href="../decay/">Decay schedule API 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.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 13:31">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/cheatsheet/index.html

@@ -14,4 +14,4 @@
 # but it could be any schedule
 s = Exp(lr, factor)
 predicate = Flux.plateau(accuracy_func, patience; min_dist = threshold)
-ParameterSchedulers.Stateful(s; advance = predicate)</code></pre><p>Using this approach, we can be more flexible than PyTorch. You can use any schedule (not just exponential decay) and arbitrary predicates. Make sure to check out the <a href="https://fluxml.ai/Flux.jl/stable/utilities/#Patience-Helpers">Flux docmentation on &quot;patience helpers&quot;</a> for more ways to customize the predicate (e.g. the <code>&#39;min&#39;</code> mode for <code>ReduceLROnPlateau</code>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/getting-started/">Getting started »</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="Thursday 28 March 2024 02:49">Thursday 28 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ParameterSchedulers.Stateful(s; advance = predicate)</code></pre><p>Using this approach, we can be more flexible than PyTorch. You can use any schedule (not just exponential decay) and arbitrary predicates. Make sure to check out the <a href="https://fluxml.ai/Flux.jl/stable/utilities/#Patience-Helpers">Flux docmentation on &quot;patience helpers&quot;</a> for more ways to customize the predicate (e.g. the <code>&#39;min&#39;</code> mode for <code>ReduceLROnPlateau</code>).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/getting-started/">Getting started »</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.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 13:31">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>