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.

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

Document existing benchmarks #9

Merged
merged 7 commits into from
Nov 7, 2024
Merged
Changes from 1 commit
Commits
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
Next Next commit
start adding some description in the documenttaion for each benchmark pb
BatyLeo committed Oct 17, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 86777cab8e54fc542002ebf797a61caa99495e30
8 changes: 7 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -21,7 +21,13 @@ makedocs(;
format=Documenter.HTML(),
pages=[
"Home" => "index.md",
"Tutorials" => md_tutorial_files,
# "Tutorials" => md_tutorial_files,
"Benchmark problems list" => [
"benchmarks/subset_selection.md",
"benchmarks/portfolio_optimization.md",
"benchmarks/fixed_size_shortest_path.md",
"benchmarks/warcraft.md",
],
"API reference" =>
["api/interface.md", "api/decision_focused.md", "api/warcraft.md"],
],
3 changes: 3 additions & 0 deletions docs/src/benchmarks/fixed_size_shortest_path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Shortest paths

[`FixedSizeShortestPathBenchmark`](@ref)
3 changes: 3 additions & 0 deletions docs/src/benchmarks/portfolio_optimization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Portfolio Optimization

[`PortfolioOptimizationBenchmark`](@ref)
9 changes: 9 additions & 0 deletions docs/src/benchmarks/subset_selection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Subset Selection

[`SubsetSelectionBenchmark`](@ref) is a very simple benchmark problem of subset selection.

We have a set of ``n`` items, each item having an `unknown' value.
We want to select a subset of ``k`` items that maximizes the sum of the values of the selected items.

As input, we are given a feature vector, that contains exactly the value of each item.
The goal is to learn the identity mapping between the feature vector and the value of the items.
3 changes: 3 additions & 0 deletions docs/src/benchmarks/warcraft.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Warcraft

[`WarcraftBenchmark`](@ref)