build based on 3d9c1a5

dev/deserialization/index.html

@@ -13,4 +13,4 @@
 
 TensorBoardLogger.map_summaries(tb_logger) do tag, iter, val
     push!(hist, Symbol(tag), iter, val)
-end</code></pre><p>All those functions also take as optional keywork arguments a collection of iterations or tags, and will only map over summaries with the desired tags/iterations.</p><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-binding" id="TensorBoardLogger.TBReader" href="#TensorBoardLogger.TBReader"><code>TensorBoardLogger.TBReader</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TBReader(logdir)</code></pre><p>Creates a TBReader object that can be used to deserialize data but cannot be used to write. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a79d8bdc70f29c86f47a0158a575f36d96757b80/src/Deserialization/reader.jl#L1-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.tags" href="#TensorBoardLogger.tags"><code>TensorBoardLogger.tags</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tags(logger)</code></pre><p>Returns a set of all the strings used as tags in messages serialized by <code>logger</code>.</p><p><code>logger</code> can be a <code>TBLogger</code> or the path of a valid TensorBoard logdir.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a79d8bdc70f29c86f47a0158a575f36d96757b80/src/Deserialization/helpers.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.steps" href="#TensorBoardLogger.steps"><code>TensorBoardLogger.steps</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">steps(logger)</code></pre><p>Returns a set of all the steps used as tags in messages serialized by <code>logger</code>.</p><p><code>logger</code> can be a <code>TBLogger</code> or the path of a valid TensorBoard logdir.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a79d8bdc70f29c86f47a0158a575f36d96757b80/src/Deserialization/helpers.jl#L19-L26">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.map_summaries" href="#TensorBoardLogger.map_summaries"><code>TensorBoardLogger.map_summaries</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">map_summaries(fun, path; purge=true, tags=all, steps=all, smart=true)</code></pre><p>Maps the function <code>fun(name, value)</code> on all the values logged to the folder at <code>path</code>. The function is called sequentially, starting from the first event till the last.</p><p>When the keyword argument <code>purge==true</code>, if the i+1-th file begins with a purge at step <code>s</code>, the i-th file is read only up to step <code>s</code>.</p><p><code>fun</code> should take 3 arguments:     (1) a String representing the name/tag of the logged value     (2) an Integer, representing the step number     (3) a value, which can be of the following types:</p><p>Optional kwargs <code>tags</code> takes as input a collection of Strings, and will only iterate across tags summaries with a tag in that collection.</p><p>Optional kwargs <code>steps</code> takes as input a collection of integers, and will only iterate across events with step within that collection.</p><p>Optional kwarg <code>smart=[true]</code> attempts to reconstruct N-dimensional arrays, complex values and 3-dim images, that are decomposed when serialzied to tensorboard. This feature works with .proto files generated by TensorBoardLogger itself, but it is untested with files generated by TensorFlow.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a79d8bdc70f29c86f47a0158a575f36d96757b80/src/Deserialization/deserialization.jl#L211-L236">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.map_events" href="#TensorBoardLogger.map_events"><code>TensorBoardLogger.map_events</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">map_summaries(fun, path; purge=true, steps=all)</code></pre><p>Maps the function <code>fun(event)</code> on all the event logged to the folder at <code>path</code>. The function is called sequentially, starting from the first event till the last.</p><p>When the keyword argument <code>purge==true</code>, if the i+1-th file begins with a purge at step <code>s</code>, the i-th file is read only up to step <code>s</code>.</p><p>Also metadata events, without any real data attached are mapped. You can detect those by <code>hasproperty(event, :summary) == false</code></p><p>Optional kwargs <code>steps</code> takes as input a collection of integers, and will only iterate across events with step within that collection.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a79d8bdc70f29c86f47a0158a575f36d96757b80/src/Deserialization/deserialization.jl#L262-L277">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>TensorBoardLogger.map_summaries</code>. Check Documenter&#39;s build log for details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_behaviour/">« Backends</a><a class="docs-footer-nextpage" href="../extending_behaviour/">Extending »</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 22 July 2023 07:27">Saturday 22 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>All those functions also take as optional keywork arguments a collection of iterations or tags, and will only map over summaries with the desired tags/iterations.</p><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-binding" id="TensorBoardLogger.TBReader" href="#TensorBoardLogger.TBReader"><code>TensorBoardLogger.TBReader</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TBReader(logdir)</code></pre><p>Creates a TBReader object that can be used to deserialize data but cannot be used to write. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/3d9c1a554a08179785459ad7b83bce0177b90275/src/Deserialization/reader.jl#L1-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.tags" href="#TensorBoardLogger.tags"><code>TensorBoardLogger.tags</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tags(logger)</code></pre><p>Returns a set of all the strings used as tags in messages serialized by <code>logger</code>.</p><p><code>logger</code> can be a <code>TBLogger</code> or the path of a valid TensorBoard logdir.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/3d9c1a554a08179785459ad7b83bce0177b90275/src/Deserialization/helpers.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.steps" href="#TensorBoardLogger.steps"><code>TensorBoardLogger.steps</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">steps(logger)</code></pre><p>Returns a set of all the steps used as tags in messages serialized by <code>logger</code>.</p><p><code>logger</code> can be a <code>TBLogger</code> or the path of a valid TensorBoard logdir.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/3d9c1a554a08179785459ad7b83bce0177b90275/src/Deserialization/helpers.jl#L19-L26">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.map_summaries" href="#TensorBoardLogger.map_summaries"><code>TensorBoardLogger.map_summaries</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">map_summaries(fun, path; purge=true, tags=all, steps=all, smart=true)</code></pre><p>Maps the function <code>fun(name, value)</code> on all the values logged to the folder at <code>path</code>. The function is called sequentially, starting from the first event till the last.</p><p>When the keyword argument <code>purge==true</code>, if the i+1-th file begins with a purge at step <code>s</code>, the i-th file is read only up to step <code>s</code>.</p><p><code>fun</code> should take 3 arguments:     (1) a String representing the name/tag of the logged value     (2) an Integer, representing the step number     (3) a value, which can be of the following types:</p><p>Optional kwargs <code>tags</code> takes as input a collection of Strings, and will only iterate across tags summaries with a tag in that collection.</p><p>Optional kwargs <code>steps</code> takes as input a collection of integers, and will only iterate across events with step within that collection.</p><p>Optional kwarg <code>smart=[true]</code> attempts to reconstruct N-dimensional arrays, complex values and 3-dim images, that are decomposed when serialzied to tensorboard. This feature works with .proto files generated by TensorBoardLogger itself, but it is untested with files generated by TensorFlow.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/3d9c1a554a08179785459ad7b83bce0177b90275/src/Deserialization/deserialization.jl#L211-L236">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorBoardLogger.map_events" href="#TensorBoardLogger.map_events"><code>TensorBoardLogger.map_events</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">map_summaries(fun, path; purge=true, steps=all)</code></pre><p>Maps the function <code>fun(event)</code> on all the event logged to the folder at <code>path</code>. The function is called sequentially, starting from the first event till the last.</p><p>When the keyword argument <code>purge==true</code>, if the i+1-th file begins with a purge at step <code>s</code>, the i-th file is read only up to step <code>s</code>.</p><p>Also metadata events, without any real data attached are mapped. You can detect those by <code>hasproperty(event, :summary) == false</code></p><p>Optional kwargs <code>steps</code> takes as input a collection of integers, and will only iterate across events with step within that collection.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/3d9c1a554a08179785459ad7b83bce0177b90275/src/Deserialization/deserialization.jl#L262-L277">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>TensorBoardLogger.map_summaries</code>. Check Documenter&#39;s build log for details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_behaviour/">« Backends</a><a class="docs-footer-nextpage" href="../extending_behaviour/">Extending »</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="Tuesday 25 July 2023 17:35">Tuesday 25 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/flux/index.html

@@ -87,4 +87,4 @@
 minibatches = minibatches |> gpu
 
 # Train
-@Flux.epochs 15 Flux.train!(loss, params(model), minibatches, opt, cb = Flux.throttle(TBCallback, 5))</code></pre><p>The resulting TensorBoard interface will be:</p><pre><code class="language-bash hljs">tensorboard --logdir content</code></pre><p><img src="../flux1.png" alt="flux1_plot"/> <img src="../flux2.png" alt="flux2_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../hyperparameters/">« Hyperparameter logging</a><a class="docs-footer-nextpage" href="../optim/">Optim.jl »</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 22 July 2023 07:27">Saturday 22 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+@Flux.epochs 15 Flux.train!(loss, params(model), minibatches, opt, cb = Flux.throttle(TBCallback, 5))</code></pre><p>The resulting TensorBoard interface will be:</p><pre><code class="language-bash hljs">tensorboard --logdir content</code></pre><p><img src="../flux1.png" alt="flux1_plot"/> <img src="../flux2.png" alt="flux2_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../hyperparameters/">« Hyperparameter logging</a><a class="docs-footer-nextpage" href="../optim/">Optim.jl »</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="Tuesday 25 July 2023 17:35">Tuesday 25 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/hyperparameter_tuning/index.html

@@ -29,4 +29,4 @@
         run_experiment(id, config)
         id += 1
     end
-end</code></pre><p>Below is an example of the dashboard you get when you open Tensorboard with the command:</p><pre><code class="language-sh hljs">tensorboard --logdir=random_walk</code></pre><p><img src="../tuning.png" alt="tuning plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optim/">« Optim.jl</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 22 July 2023 07:27">Saturday 22 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>Below is an example of the dashboard you get when you open Tensorboard with the command:</p><pre><code class="language-sh hljs">tensorboard --logdir=random_walk</code></pre><p><img src="../tuning.png" alt="tuning plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optim/">« Optim.jl</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="Tuesday 25 July 2023 17:35">Tuesday 25 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>