Merge pull request #141 from ldeso/Fix-docs

Fix missing/duplicate docs
JuliaLogging · Oct 11, 2023 · e985f09 · e985f09
2 parents 37bae6b + 2b63929
commit e985f09
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -11,14 +11,16 @@ 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"
                 "Optim.jl"  => "examples/optim.md"
                 "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
@@ -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
@@ -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
@@ -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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.