Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing/duplicate docs #141

Merged
merged 1 commit into from
Oct 11, 2023
+17 −2
Merged

Fix missing/duplicate docs #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
)
Expand Down
1 change: 0 additions & 1 deletion docs/src/deserialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,4 @@ TensorBoardLogger.tags
TensorBoardLogger.steps
map_summaries
TensorBoardLogger.map_events
TensorBoardLogger.map_summaries
```
11 changes: 11 additions & 0 deletions docs/src/exported.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Exported

```@docs
TBLogger
reset!
set_step!
increment_step!
with_TBLogger_hold_step
TensorBoardLogger.set_step_increment!
TensorBoardLogger.PNGImage.PngImage
```
3 changes: 3 additions & 0 deletions docs/src/index.md
View file
Open in desktop
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.
Loading