From 2b6392963e17c1f9e94920f4801b4e50f4210342 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20de=20Souza?= Date: Tue, 10 Oct 2023 14:27:35 +0200 Subject: [PATCH] Fix missing/duplicate docs --- docs/make.jl | 4 +++- docs/src/deserialization.md | 1 - docs/src/exported.md | 11 +++++++++++ docs/src/index.md | 3 +++ 4 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/src/exported.md diff --git a/docs/make.jl b/docs/make.jl index a9d1882..9a726fa 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -11,7 +11,8 @@ makedocs( "Reading back data" => "deserialization.md", "Extending" => "extending_behaviour.md", "Explicit Interface" => "explicit_interface.md", - "Hyperparameter logging" => "hyperparameters.md" + "Hyperparameter logging" => "hyperparameters.md", + "Exported" => "exported.md" ], "Examples" => Any[ "Flux.jl" => "examples/flux.md" @@ -19,6 +20,7 @@ makedocs( "Hyperparameter tuning" => "examples/hyperparameter_tuning.md" ] ], + checkdocs = :exports, format = Documenter.HTML( prettyurls = haskey(ENV, "CI")) ) diff --git a/docs/src/deserialization.md b/docs/src/deserialization.md index 8506f84..71e228c 100644 --- a/docs/src/deserialization.md +++ b/docs/src/deserialization.md @@ -50,5 +50,4 @@ TensorBoardLogger.tags TensorBoardLogger.steps map_summaries TensorBoardLogger.map_events -TensorBoardLogger.map_summaries ``` diff --git a/docs/src/exported.md b/docs/src/exported.md new file mode 100644 index 0000000..f1d72da --- /dev/null +++ b/docs/src/exported.md @@ -0,0 +1,11 @@ +# Exported + +```@docs +TBLogger +reset! +set_step! +increment_step! +with_TBLogger_hold_step +TensorBoardLogger.set_step_increment! +TensorBoardLogger.PNGImage.PngImage +``` diff --git a/docs/src/index.md b/docs/src/index.md index d589f96..8ec63ff 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -123,3 +123,6 @@ As an alternative, you can also log data to TensorBoard through its functional i 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 [Hyperparameter logging](@ref) manual page. +## Other exported methods + +For documentation on other exported methods, see the [Exported](@ref) manual page.