build based on 6c8daf5

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-15T15:18:55","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-28T20:07:13","documenter_version":"1.2.1"}}

dev/ci/index.html

@@ -24,10 +24,10 @@
 julia> @test_benchmarks Example
 │ Test Summary:  | Pass  Total
 │ bench_timer.jl |    2      2
-[...]</code></pre><p><strong>Testing</strong></p><p>Each benchmark is wrapped in a <code>@testset</code>, run only once, and marked as passing iff no errors are raised. This provides a fast smoke test for a benchmarking suite, and avoids the usual cost of tunning, warming up and collecting samples accrued when actually benchmarking.</p><p><strong>Benchmark Loading</strong></p><p>Locating benchmarks for testing is the same as for <a href="../jogger/#PkgJogger.@jog"><code>@jog</code></a> and can be examined using <a href="../reference/#PkgJogger.locate_benchmarks"><code>PkgJogger.locate_benchmarks</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/22ccb6b0b566a0ecc76c26b81a00b0d30a6b6e1b/src/utils.jl#L133-L159">source</a></section></article><h2 id="Reference"><a class="docs-heading-anchor" href="#Reference">Reference</a><a id="Reference-1"></a><a class="docs-heading-anchor-permalink" href="#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="PkgJogger.ci" href="#PkgJogger.ci"><code>PkgJogger.ci</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Sets up an isolated benchmarking environment and then runs the following:</p><pre><code class="language-julia hljs">using PkgJogger
+[...]</code></pre><p><strong>Testing</strong></p><p>Each benchmark is wrapped in a <code>@testset</code>, run only once, and marked as passing iff no errors are raised. This provides a fast smoke test for a benchmarking suite, and avoids the usual cost of tunning, warming up and collecting samples accrued when actually benchmarking.</p><p><strong>Benchmark Loading</strong></p><p>Locating benchmarks for testing is the same as for <a href="../jogger/#PkgJogger.@jog"><code>@jog</code></a> and can be examined using <a href="../reference/#PkgJogger.locate_benchmarks"><code>PkgJogger.locate_benchmarks</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/6c8daf5e0c4a1979a87d2fce081838685215d587/src/utils.jl#L133-L159">source</a></section></article><h2 id="Reference"><a class="docs-heading-anchor" href="#Reference">Reference</a><a id="Reference-1"></a><a class="docs-heading-anchor-permalink" href="#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="PkgJogger.ci" href="#PkgJogger.ci"><code>PkgJogger.ci</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Sets up an isolated benchmarking environment and then runs the following:</p><pre><code class="language-julia hljs">using PkgJogger
 using PkgName
 jogger = @jog PkgName
 result = JogPkgName.benchmark()
 filename = JogPkgName.save_benchmarks(result)
 @info &quot;Saved benchmarks to $filename&quot;
-</code></pre><p>Where <code>PkgName</code> is the name of the package in the current directory</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/22ccb6b0b566a0ecc76c26b81a00b0d30a6b6e1b/src/ci.jl#L1-L17">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="PkgJogger.JOGGER_PKGS" href="#PkgJogger.JOGGER_PKGS"><code>PkgJogger.JOGGER_PKGS</code></a> — <span class="docstring-category">Constant</span></header><section><div><p>Packages that are required by modules created with <a href="../jogger/#PkgJogger.@jog"><code>@jog</code></a></p><p>Generated modules will access these via <code>Base.loaded_modules</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/22ccb6b0b566a0ecc76c26b81a00b0d30a6b6e1b/src/PkgJogger.jl#L17-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../io/">« Saving Results</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 15 February 2024 15:18">Thursday 15 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>Where <code>PkgName</code> is the name of the package in the current directory</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/6c8daf5e0c4a1979a87d2fce081838685215d587/src/ci.jl#L1-L17">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="PkgJogger.JOGGER_PKGS" href="#PkgJogger.JOGGER_PKGS"><code>PkgJogger.JOGGER_PKGS</code></a> — <span class="docstring-category">Constant</span></header><section><div><p>Packages that are required by modules created with <a href="../jogger/#PkgJogger.@jog"><code>@jog</code></a></p><p>Generated modules will access these via <code>Base.loaded_modules</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awadell1/PkgJogger.jl/blob/6c8daf5e0c4a1979a87d2fce081838685215d587/src/PkgJogger.jl#L17-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../io/">« Saving Results</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 28 February 2024 20:07">Wednesday 28 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -13,4 +13,4 @@
 @jog AwesomePkg
 
 # Warmup, tune, and run all of AwesomePkg's benchmarks
-JogAwesomePkg.benchmark()</code></pre><h2 id="Benchmark,-Revise,-and-Benchmark-Again!"><a class="docs-heading-anchor" href="#Benchmark,-Revise,-and-Benchmark-Again!">Benchmark, Revise, and Benchmark Again!</a><a id="Benchmark,-Revise,-and-Benchmark-Again!-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmark,-Revise,-and-Benchmark-Again!" title="Permalink"></a></h2><p>PkgJogger uses <a href="https://github.com/timholy/Revise.jl">Revise.jl</a> to track changes to your <code>benchmark/bench_*.jl</code> files and reload your suite as you edit. No more waiting for benchmarks to precompile!</p><p>Tracked Changes:</p><ul><li>Changing your benchmarked function</li><li>Changing benchmarking parameters (i.e. <code>seconds</code> or <code>samples</code>)</li><li>Adding new benchmarks</li></ul><p>Current Limitations:</p><ul><li>New benchmark files are not tracked</li><li>Deleted benchmarks will stick around</li><li>Renamed benchmarks will create a new benchmark and retain the old name</li></ul><p>To get around the above, run <code>@jog PkgName</code> to get an updated jogger.</p><blockquote><p>Note: Revise must be loaded first in order to track changes to your benchmark files.</p></blockquote><h2 id="Continuous-Benchmarking-Baked-In!"><a class="docs-heading-anchor" href="#Continuous-Benchmarking-Baked-In!">Continuous Benchmarking Baked In!</a><a id="Continuous-Benchmarking-Baked-In!-1"></a><a class="docs-heading-anchor-permalink" href="#Continuous-Benchmarking-Baked-In!" title="Permalink"></a></h2><p>Install PkgJogger, run benchmarks, and save results to a <code>*.bson.gz</code> with a one-line command.</p><pre><code class="language-shell hljs">julia -e &#39;using Pkg; Pkg.add(&quot;PkgJogger&quot;); using PkgJogger; PkgJogger.ci()&#39;</code></pre><p>What gets done:</p><ul><li>Constructs a temporary <a href="https://awadell1.github.io/PkgJogger.jl/stable/ci/#Isolated-Benchmarking-Environment">benchmarking environment</a> from <code>Project.toml</code> and <code>benchmark/Project.toml</code>.</li><li>Creates a <a href="https://awadell1.github.io/PkgJogger.jl/stable/jogger/">jogger</a> to run the package&#39;s benchmarks.</li><li>Warmup, tune and run all benchmarks.</li><li>Save Benchmarking results and more to a compressed <code>*.bson.gz</code> file.</li></ul><p>Or for a more lightweight option, use <a href="https://awadell1.github.io/PkgJogger.jl/stable/ci/#Testing-Benchmarks"><code>@test_bechmarks</code></a> to run each benchmark once (No Warmup, tuning, etc.), as a smoke test against benchmarking regressions.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="jogger/">Jogger »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 15 February 2024 15:18">Thursday 15 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+JogAwesomePkg.benchmark()</code></pre><h2 id="Benchmark,-Revise,-and-Benchmark-Again!"><a class="docs-heading-anchor" href="#Benchmark,-Revise,-and-Benchmark-Again!">Benchmark, Revise, and Benchmark Again!</a><a id="Benchmark,-Revise,-and-Benchmark-Again!-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmark,-Revise,-and-Benchmark-Again!" title="Permalink"></a></h2><p>PkgJogger uses <a href="https://github.com/timholy/Revise.jl">Revise.jl</a> to track changes to your <code>benchmark/bench_*.jl</code> files and reload your suite as you edit. No more waiting for benchmarks to precompile!</p><p>Tracked Changes:</p><ul><li>Changing your benchmarked function</li><li>Changing benchmarking parameters (i.e. <code>seconds</code> or <code>samples</code>)</li><li>Adding new benchmarks</li></ul><p>Current Limitations:</p><ul><li>New benchmark files are not tracked</li><li>Deleted benchmarks will stick around</li><li>Renamed benchmarks will create a new benchmark and retain the old name</li></ul><p>To get around the above, run <code>@jog PkgName</code> to get an updated jogger.</p><blockquote><p>Note: Revise must be loaded first in order to track changes to your benchmark files.</p></blockquote><h2 id="Continuous-Benchmarking-Baked-In!"><a class="docs-heading-anchor" href="#Continuous-Benchmarking-Baked-In!">Continuous Benchmarking Baked In!</a><a id="Continuous-Benchmarking-Baked-In!-1"></a><a class="docs-heading-anchor-permalink" href="#Continuous-Benchmarking-Baked-In!" title="Permalink"></a></h2><p>Install PkgJogger, run benchmarks, and save results to a <code>*.bson.gz</code> with a one-line command.</p><pre><code class="language-shell hljs">julia -e &#39;using Pkg; Pkg.add(&quot;PkgJogger&quot;); using PkgJogger; PkgJogger.ci()&#39;</code></pre><p>What gets done:</p><ul><li>Constructs a temporary <a href="https://awadell1.github.io/PkgJogger.jl/stable/ci/#Isolated-Benchmarking-Environment">benchmarking environment</a> from <code>Project.toml</code> and <code>benchmark/Project.toml</code>.</li><li>Creates a <a href="https://awadell1.github.io/PkgJogger.jl/stable/jogger/">jogger</a> to run the package&#39;s benchmarks.</li><li>Warmup, tune and run all benchmarks.</li><li>Save Benchmarking results and more to a compressed <code>*.bson.gz</code> file.</li></ul><p>Or for a more lightweight option, use <a href="https://awadell1.github.io/PkgJogger.jl/stable/ci/#Testing-Benchmarks"><code>@test_bechmarks</code></a> to run each benchmark once (No Warmup, tuning, etc.), as a smoke test against benchmarking regressions.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="jogger/">Jogger »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 28 February 2024 20:07">Wednesday 28 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>