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 docs benchmark #58

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Fix docs benchmark #58

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
3 changes: 1 addition & 2 deletions .github/workflows/docs-benchmark.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ jobs:
using Pkg
Pkg.instantiate()
include("benchmark/run_benchmarks.jl")
include("benchmark/process_benchmarks.jl")
ENV["HMM_BENCHMARKS_DONE"] = true'
include("benchmark/process_benchmarks.jl")'
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
14 changes: 7 additions & 7 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ open(joinpath(joinpath(@__DIR__, "src"), "index.md"), "w") do io
end
end

alt_pages = if get(ENV, "HMM_BENCHMARKS_DONE", false)
["Features" => "alt_features.md", "Performance" => "alt_performance.md"]
else
["Features" => "alt_features.md"]
end
benchmarks_done = (
(length(readdir(joinpath(@__DIR__, "src", "assets", "benchmark", "plots"))) > 1) && # plots present
(length(readdir(joinpath(@__DIR__, "src", "assets", "benchmark", "results"))) > 1) # results present
)

pages = [
"Home" => "index.md",
Expand All @@ -36,7 +35,8 @@ pages = [
"Custom HMM" => "tuto_custom.md",
"Debugging" => "debugging.md",
],
"Alternatives" => alt_pages,
"Alternatives" =>
["Features" => "alt_features.md", "Performance" => "alt_performance.md"],
"Advanced" => ["Formulas" => "formulas.md", "Roadmap" => "roadmap.md"],
]

Expand All @@ -54,7 +54,7 @@ makedocs(;
format=fmt,
pages=pages,
plugins=[bib],
pagesonly=true,
warnonly=!benchmarks_done,
)

deploydocs(; repo="github.com/gdalle/HiddenMarkovModels.jl", devbranch="main")
4 changes: 4 additions & 0 deletions docs/src/alt_performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ The test case is an HMM with diagonal multivariate normal observations.
- `K`: number of trajectories
- `I`: number of Baum-Welch iterations

!!! danger "Missing benchmarks?"
The benchmarks are computationally expensive and we only run them once for each new release.
If you don't see any plots below and the links are broken, you are probably on the dev documentation: go to the [stable documentation](https://gdalle.github.io/HiddenMarkovModels.jl/stable/) instead.

## Reproducibility

These benchmarks were generated in the following environment: [`setup.txt`](./assets/benchmark/results/setup.txt).
Expand Down
Loading