build based on a2b97d4

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-11T06:25:12","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-05-14T11:27:48","documenter_version":"1.4.1"}}

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-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><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/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/Deserialization/reader.jl#L1-L6">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="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/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/Deserialization/helpers.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="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/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/Deserialization/helpers.jl#L19-L26">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="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/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/Deserialization/deserialization.jl#L217-L242">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="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/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/Deserialization/deserialization.jl#L268-L283">source</a></section></article></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="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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.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-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><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/a2b97d456c605d63c96c0af07c348f05372d7719/src/Deserialization/reader.jl#L1-L6">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="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/a2b97d456c605d63c96c0af07c348f05372d7719/src/Deserialization/helpers.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="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/a2b97d456c605d63c96c0af07c348f05372d7719/src/Deserialization/helpers.jl#L19-L26">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="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/a2b97d456c605d63c96c0af07c348f05372d7719/src/Deserialization/deserialization.jl#L217-L242">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="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/a2b97d456c605d63c96c0af07c348f05372d7719/src/Deserialization/deserialization.jl#L268-L283">source</a></section></article></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="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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.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="../../exported/">« Exported</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="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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.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="../../exported/">« Exported</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="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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.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="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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.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="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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/optim/index.html

@@ -19,4 +19,4 @@
 
 
 rosenbrock(x) =  (1.0 - x[1])^2 + 100.0 * (x[2] - x[1]^2)^2
-result = optimize(rosenbrock, zeros(2), BFGS(), Optim.Options(callback=make_tensorboardlogger_callback()))</code></pre><p><img src="../optim.png" alt="optim_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flux/">« Flux.jl</a><a class="docs-footer-nextpage" href="../hyperparameter_tuning/">Hyperparameter tuning »</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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+result = optimize(rosenbrock, zeros(2), BFGS(), Optim.Options(callback=make_tensorboardlogger_callback()))</code></pre><p><img src="../optim.png" alt="optim_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../flux/">« Flux.jl</a><a class="docs-footer-nextpage" href="../hyperparameter_tuning/">Hyperparameter tuning »</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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/exported/index.html

@@ -4,7 +4,7 @@
         prefix="",
         purge_step=nothing, 
         step_increment=1, 
-        min_level=Logging.Info)</code></pre><p>Creates a TensorBoardLogger in the folder <code>logdir</code>. The second (optional) argument specifies the behaviour if the <code>logdir</code> already exhists: the default choice <code>tb_increment</code> appends an increasing number 1,2... to <code>logdir</code>. Other choices are <code>tb_overwrite</code>, which overwrites the previous folder, and <code>tb_append</code>, which adds to any existing logs.</p><p>Optional keyword argument <code>prefix</code> can be passed to prepend a path to the file name (note, not the log directory). See <code>create_eventfile()</code></p><p>If a <code>purge_step::Int</code> is passed, every step before <code>purge_step</code> will be ignored by tensorboard (usefull in the case of restarting a crashed computation).</p><p><code>min_level</code> specifies the minimum level of messages logged to tensorboard.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L30-L52">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="TensorBoardLogger.reset!" href="#TensorBoardLogger.reset!"><code>TensorBoardLogger.reset!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reset!(lg)</code></pre><p>Reset the TBLogger <code>lg</code>, deleting everything in its log directory.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L225-L229">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="TensorBoardLogger.set_step!" href="#TensorBoardLogger.set_step!"><code>TensorBoardLogger.set_step!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_step!(lg, step) -&gt; Int</code></pre><p>Sets the iteration counter in the logger to <code>step</code>. This counter is used by the logger when no value is passed by the user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L178-L183">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="TensorBoardLogger.increment_step!" href="#TensorBoardLogger.increment_step!"><code>TensorBoardLogger.increment_step!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">increment_step!(lg, Δ_Step) -&gt; Int</code></pre><p>Increments the step counter in the logger by <code>Δ_Step</code> and returns the new value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L196-L200">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="TensorBoardLogger.with_TBLogger_hold_step" href="#TensorBoardLogger.with_TBLogger_hold_step"><code>TensorBoardLogger.with_TBLogger_hold_step</code></a> — <span class="docstring-category">Function</span></header><section><div><p><code>with_TBLogger_hold_step(f, [step]; step_at_end::Bool=true)</code> Context function to ease control of logging steps and synchronization. Amount of step increment can be controlled via <code>set_step_increment!</code>`.</p><p>Example:</p><pre><code class="language-julia hljs">with_logger(lg) do
+        min_level=Logging.Info)</code></pre><p>Creates a TensorBoardLogger in the folder <code>logdir</code>. The second (optional) argument specifies the behaviour if the <code>logdir</code> already exhists: the default choice <code>tb_increment</code> appends an increasing number 1,2... to <code>logdir</code>. Other choices are <code>tb_overwrite</code>, which overwrites the previous folder, and <code>tb_append</code>, which adds to any existing logs.</p><p>Optional keyword argument <code>prefix</code> can be passed to prepend a path to the file name (note, not the log directory). See <code>create_eventfile()</code></p><p>If a <code>purge_step::Int</code> is passed, every step before <code>purge_step</code> will be ignored by tensorboard (usefull in the case of restarting a crashed computation).</p><p><code>min_level</code> specifies the minimum level of messages logged to tensorboard.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L30-L52">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="TensorBoardLogger.reset!" href="#TensorBoardLogger.reset!"><code>TensorBoardLogger.reset!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reset!(lg)</code></pre><p>Reset the TBLogger <code>lg</code>, deleting everything in its log directory.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L225-L229">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="TensorBoardLogger.set_step!" href="#TensorBoardLogger.set_step!"><code>TensorBoardLogger.set_step!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_step!(lg, step) -&gt; Int</code></pre><p>Sets the iteration counter in the logger to <code>step</code>. This counter is used by the logger when no value is passed by the user.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L178-L183">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="TensorBoardLogger.increment_step!" href="#TensorBoardLogger.increment_step!"><code>TensorBoardLogger.increment_step!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">increment_step!(lg, Δ_Step) -&gt; Int</code></pre><p>Increments the step counter in the logger by <code>Δ_Step</code> and returns the new value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L196-L200">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="TensorBoardLogger.with_TBLogger_hold_step" href="#TensorBoardLogger.with_TBLogger_hold_step"><code>TensorBoardLogger.with_TBLogger_hold_step</code></a> — <span class="docstring-category">Function</span></header><section><div><p><code>with_TBLogger_hold_step(f, [step]; step_at_end::Bool=true)</code> Context function to ease control of logging steps and synchronization. Amount of step increment can be controlled via <code>set_step_increment!</code>`.</p><p>Example:</p><pre><code class="language-julia hljs">with_logger(lg) do
     for epoch in 1:10
         for i=1:100
             # increments global_step by default
@@ -25,4 +25,4 @@
             @info &quot;test3/scalar&quot; i3=i^3
         end
     end
-end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L303-L334">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="TensorBoardLogger.set_step_increment!" href="#TensorBoardLogger.set_step_increment!"><code>TensorBoardLogger.set_step_increment!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_step_increment!(lg, increment) -&gt; Int</code></pre><p>Sets the default increment applyed to logger <code>lg</code>&#39;s iteration counter each time logging is performed.</p><p>Can be overidden by passing <code>log_step_increment=some_increment</code> when logging.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/TBLogger.jl#L186-L193">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="TensorBoardLogger.PNGImage.PngImage" href="#TensorBoardLogger.PNGImage.PngImage"><code>TensorBoardLogger.PNGImage.PngImage</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PngImage</code></pre><p>A wrapper around the binary encoding of a PNG image, holding its attributes</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/e0dcbb3572f9cdb4ca8be645207c6ff6f95bfe6d/src/PNG.jl#L12-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../hyperparameters/">« Hyperparameter logging</a><a class="docs-footer-nextpage" href="../examples/flux/">Flux.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="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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L303-L334">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="TensorBoardLogger.set_step_increment!" href="#TensorBoardLogger.set_step_increment!"><code>TensorBoardLogger.set_step_increment!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_step_increment!(lg, increment) -&gt; Int</code></pre><p>Sets the default increment applyed to logger <code>lg</code>&#39;s iteration counter each time logging is performed.</p><p>Can be overidden by passing <code>log_step_increment=some_increment</code> when logging.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/TBLogger.jl#L186-L193">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="TensorBoardLogger.PNGImage.PngImage" href="#TensorBoardLogger.PNGImage.PngImage"><code>TensorBoardLogger.PNGImage.PngImage</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PngImage</code></pre><p>A wrapper around the binary encoding of a PNG image, holding its attributes</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/a2b97d456c605d63c96c0af07c348f05372d7719/src/PNG.jl#L12-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../hyperparameters/">« Hyperparameter logging</a><a class="docs-footer-nextpage" href="../examples/flux/">Flux.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="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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/extending_behaviour/index.html

@@ -9,4 +9,4 @@
 cost_fun = LinkedQuantities(&quot;Loss&quot;, 0.5+0.1im, &quot;Loss_Variance&quot;, 0.01+0.02im)</code></pre><p>and consider that you want to log objects of this type so that it logs <code>val_1</code> with the tag <code>name_1</code> and <code>val_2</code> with tag <code>name_2</code>. To achieve that, one defines</p><pre><code class="nohighlight hljs">function preprocess(name, val::LinkedQuantities, data)
   preprocess(val.name_1, val.val_1, data)
   preprocess(val.name_2, val.val_2, data)
-end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../deserialization/">« Reading back data</a><a class="docs-footer-nextpage" href="../explicit_interface/">Explicit Interface »</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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../deserialization/">« Reading back data</a><a class="docs-footer-nextpage" href="../explicit_interface/">Explicit Interface »</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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -20,4 +20,4 @@
         @info "" my_weird_struct=data_struct   log_step_increment=0
         @debug "debug_msg" this_wont_show_up=i
     end
-end</code></pre><h2 id="Backends"><a class="docs-heading-anchor" href="#Backends">Backends</a><a id="Backends-1"></a><a class="docs-heading-anchor-permalink" href="#Backends" title="Permalink"></a></h2><p><em>TensorBoardLogger</em> supports five backends:     - Scalars     - Distributions     - Images     - Audio     - Text/Markdown</p><p>When you log data to tensorboard, it is processed to convert it to the format used by TensorBoard. In particular, fields in structures are logged individually and complex numbers/arrays are split into their real and imaginary parts. Depending on its type, an object is serialized to the relevant backend, with the text backend being the default fallback.</p><p>For more detailed informations on how data is dispatched to a certain backend, and how to specify a desired backend refer to <a href="custom_behaviour/#Specifying-a-backend">Specifying a backend</a>.</p><p>If you want to define a new default behaviour for a custom type refer to section <a href="extending_behaviour/#Extending-TensorBoardLogger">Extending TensorBoardLogger</a>.</p><h2 id="Deserialization"><a class="docs-heading-anchor" href="#Deserialization">Deserialization</a><a id="Deserialization-1"></a><a class="docs-heading-anchor-permalink" href="#Deserialization" title="Permalink"></a></h2><p>If you want to read back the data stored in TensorBoard/.proto files, have a look at <a href="deserialization/#Reading-back-TensorBoard-data">Reading back TensorBoard data</a></p><h2 id="Third-party-packages"><a class="docs-heading-anchor" href="#Third-party-packages">Third-party packages</a><a id="Third-party-packages-1"></a><a class="docs-heading-anchor-permalink" href="#Third-party-packages" title="Permalink"></a></h2><p>We also support logging custom types from a the following third-party libraries:</p><ul><li><a href="https://github.com/JuliaPlots/Plots.jl">Plots.jl</a>: the <code>Plots.Plot</code> type will be rendered to PNG at the resolution specified by the object and logged as an image</li><li><a href="https://github.com/JuliaPy/PyPlot.jl">PyPlot.jl</a>: the <code>PyPlot.Figure</code> type will be rendered to PNG at the resolution specified by the object and logged as an image</li><li><a href="https://github.com/GiovineItalia/Gadfly.jl">Gadfly.jl</a>: the <code>Gadfly.Plot</code> type will be rendered to PNG at the resolution specified by the object and logged as an image. <code>Cairo</code> and <code>Fontconfig</code> packages must be imported for this functionality to work as it is required by <code>Gadfly</code>.</li><li><a href="https://github.com/FluxML/Tracker.jl">Tracker.jl</a>: the <code>TrackedReal</code> and <code>TrackedArray</code> types will be logged as vector data</li><li><a href="https://github.com/JuliaML/ValueHistories.jl">ValueHistories.jl</a>: the <code>MVHistory</code> type is used to store the deserialized content of .proto files.</li></ul><h2 id="Explicit-logging"><a class="docs-heading-anchor" href="#Explicit-logging">Explicit logging</a><a id="Explicit-logging-1"></a><a class="docs-heading-anchor-permalink" href="#Explicit-logging" title="Permalink"></a></h2><p>As an alternative, you can also log data to TensorBoard through its functional interface, by calling the relevant method with a tag string and the data. For information on this interface refer to <a href="explicit_interface/#Explicit-interface">Explicit interface</a>.</p><h2 id="Hyperparameter-tuning"><a class="docs-heading-anchor" href="#Hyperparameter-tuning">Hyperparameter tuning</a><a id="Hyperparameter-tuning-1"></a><a class="docs-heading-anchor-permalink" href="#Hyperparameter-tuning" title="Permalink"></a></h2><p>Many experiments rely on hyperparameters, which can be difficult to tune. Tensorboard allows you to visualise the effect of your hyperparameters on your metrics, giving you an intuition for the correct hyperparameters for your task. For information on this API, see the <a href="hyperparameters/#Hyperparameter-logging">Hyperparameter logging</a> manual page.</p><h2 id="Other-exported-methods"><a class="docs-heading-anchor" href="#Other-exported-methods">Other exported methods</a><a id="Other-exported-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Other-exported-methods" title="Permalink"></a></h2><p>For documentation on other exported methods, see the <a href="exported/#Exported">Exported</a> manual page.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="custom_behaviour/">Backends »</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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><h2 id="Backends"><a class="docs-heading-anchor" href="#Backends">Backends</a><a id="Backends-1"></a><a class="docs-heading-anchor-permalink" href="#Backends" title="Permalink"></a></h2><p><em>TensorBoardLogger</em> supports five backends:     - Scalars     - Distributions     - Images     - Audio     - Text/Markdown</p><p>When you log data to tensorboard, it is processed to convert it to the format used by TensorBoard. In particular, fields in structures are logged individually and complex numbers/arrays are split into their real and imaginary parts. Depending on its type, an object is serialized to the relevant backend, with the text backend being the default fallback.</p><p>For more detailed informations on how data is dispatched to a certain backend, and how to specify a desired backend refer to <a href="custom_behaviour/#Specifying-a-backend">Specifying a backend</a>.</p><p>If you want to define a new default behaviour for a custom type refer to section <a href="extending_behaviour/#Extending-TensorBoardLogger">Extending TensorBoardLogger</a>.</p><h2 id="Deserialization"><a class="docs-heading-anchor" href="#Deserialization">Deserialization</a><a id="Deserialization-1"></a><a class="docs-heading-anchor-permalink" href="#Deserialization" title="Permalink"></a></h2><p>If you want to read back the data stored in TensorBoard/.proto files, have a look at <a href="deserialization/#Reading-back-TensorBoard-data">Reading back TensorBoard data</a></p><h2 id="Third-party-packages"><a class="docs-heading-anchor" href="#Third-party-packages">Third-party packages</a><a id="Third-party-packages-1"></a><a class="docs-heading-anchor-permalink" href="#Third-party-packages" title="Permalink"></a></h2><p>We also support logging custom types from a the following third-party libraries:</p><ul><li><a href="https://github.com/JuliaPlots/Plots.jl">Plots.jl</a>: the <code>Plots.Plot</code> type will be rendered to PNG at the resolution specified by the object and logged as an image</li><li><a href="https://github.com/JuliaPy/PyPlot.jl">PyPlot.jl</a>: the <code>PyPlot.Figure</code> type will be rendered to PNG at the resolution specified by the object and logged as an image</li><li><a href="https://github.com/GiovineItalia/Gadfly.jl">Gadfly.jl</a>: the <code>Gadfly.Plot</code> type will be rendered to PNG at the resolution specified by the object and logged as an image. <code>Cairo</code> and <code>Fontconfig</code> packages must be imported for this functionality to work as it is required by <code>Gadfly</code>.</li><li><a href="https://github.com/FluxML/Tracker.jl">Tracker.jl</a>: the <code>TrackedReal</code> and <code>TrackedArray</code> types will be logged as vector data</li><li><a href="https://github.com/JuliaML/ValueHistories.jl">ValueHistories.jl</a>: the <code>MVHistory</code> type is used to store the deserialized content of .proto files.</li></ul><h2 id="Explicit-logging"><a class="docs-heading-anchor" href="#Explicit-logging">Explicit logging</a><a id="Explicit-logging-1"></a><a class="docs-heading-anchor-permalink" href="#Explicit-logging" title="Permalink"></a></h2><p>As an alternative, you can also log data to TensorBoard through its functional interface, by calling the relevant method with a tag string and the data. For information on this interface refer to <a href="explicit_interface/#Explicit-interface">Explicit interface</a>.</p><h2 id="Hyperparameter-tuning"><a class="docs-heading-anchor" href="#Hyperparameter-tuning">Hyperparameter tuning</a><a id="Hyperparameter-tuning-1"></a><a class="docs-heading-anchor-permalink" href="#Hyperparameter-tuning" title="Permalink"></a></h2><p>Many experiments rely on hyperparameters, which can be difficult to tune. Tensorboard allows you to visualise the effect of your hyperparameters on your metrics, giving you an intuition for the correct hyperparameters for your task. For information on this API, see the <a href="hyperparameters/#Hyperparameter-logging">Hyperparameter logging</a> manual page.</p><h2 id="Other-exported-methods"><a class="docs-heading-anchor" href="#Other-exported-methods">Other exported methods</a><a id="Other-exported-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Other-exported-methods" title="Permalink"></a></h2><p>For documentation on other exported methods, see the <a href="exported/#Exported">Exported</a> manual page.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="custom_behaviour/">Backends »</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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/logging_details/index.html

@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · TensorBoardLogger.jl</title><meta name="title" content="Introduction · TensorBoardLogger.jl"/><meta property="og:title" content="Introduction · TensorBoardLogger.jl"/><meta property="twitter:title" content="Introduction · TensorBoardLogger.jl"/><meta name="description" content="Documentation for TensorBoardLogger.jl."/><meta property="og:description" content="Documentation for TensorBoardLogger.jl."/><meta property="twitter:description" content="Documentation for TensorBoardLogger.jl."/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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="../">TensorBoardLogger.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../custom_behaviour/">Backends</a></li><li><a class="tocitem" href="../deserialization/">Reading back data</a></li><li><a class="tocitem" href="../extending_behaviour/">Extending</a></li><li><a class="tocitem" href="../explicit_interface/">Explicit Interface</a></li><li><a class="tocitem" href="../hyperparameters/">Hyperparameter logging</a></li><li><a class="tocitem" href="../exported/">Exported</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/flux/">Flux.jl</a></li><li><a class="tocitem" href="../examples/optim/">Optim.jl</a></li><li><a class="tocitem" href="../examples/hyperparameter_tuning/">Hyperparameter tuning</a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaLogging/TensorBoardLogger.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/master/docs/src/logging_details.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Introduction"><a class="docs-heading-anchor" href="#Introduction">Introduction</a><a id="Introduction-1"></a><a class="docs-heading-anchor-permalink" href="#Introduction" title="Permalink"></a></h1></article><nav class="docs-footer"><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 11 April 2024 06:25">Thursday 11 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · TensorBoardLogger.jl</title><meta name="title" content="Introduction · TensorBoardLogger.jl"/><meta property="og:title" content="Introduction · TensorBoardLogger.jl"/><meta property="twitter:title" content="Introduction · TensorBoardLogger.jl"/><meta name="description" content="Documentation for TensorBoardLogger.jl."/><meta property="og:description" content="Documentation for TensorBoardLogger.jl."/><meta property="twitter:description" content="Documentation for TensorBoardLogger.jl."/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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="../">TensorBoardLogger.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../custom_behaviour/">Backends</a></li><li><a class="tocitem" href="../deserialization/">Reading back data</a></li><li><a class="tocitem" href="../extending_behaviour/">Extending</a></li><li><a class="tocitem" href="../explicit_interface/">Explicit Interface</a></li><li><a class="tocitem" href="../hyperparameters/">Hyperparameter logging</a></li><li><a class="tocitem" href="../exported/">Exported</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/flux/">Flux.jl</a></li><li><a class="tocitem" href="../examples/optim/">Optim.jl</a></li><li><a class="tocitem" href="../examples/hyperparameter_tuning/">Hyperparameter tuning</a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaLogging/TensorBoardLogger.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaLogging/TensorBoardLogger.jl/blob/master/docs/src/logging_details.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Introduction"><a class="docs-heading-anchor" href="#Introduction">Introduction</a><a id="Introduction-1"></a><a class="docs-heading-anchor-permalink" href="#Introduction" title="Permalink"></a></h1></article><nav class="docs-footer"><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="Tuesday 14 May 2024 11:27">Tuesday 14 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>