Skip to content

Commit 86777ca

Browse files
committed
start adding some description in the documenttaion for each benchmark pb
1 parent 116a1cc commit 86777ca

File tree

5 files changed

+25
-1
lines changed

5 files changed

+25
-1
lines changed

docs/make.jl

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ makedocs(;
2121
format=Documenter.HTML(),
2222
pages=[
2323
"Home" => "index.md",
24-
"Tutorials" => md_tutorial_files,
24+
# "Tutorials" => md_tutorial_files,
25+
"Benchmark problems list" => [
26+
"benchmarks/subset_selection.md",
27+
"benchmarks/portfolio_optimization.md",
28+
"benchmarks/fixed_size_shortest_path.md",
29+
"benchmarks/warcraft.md",
30+
],
2531
"API reference" =>
2632
["api/interface.md", "api/decision_focused.md", "api/warcraft.md"],
2733
],
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Shortest paths
2+
3+
[`FixedSizeShortestPathBenchmark`](@ref)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Portfolio Optimization
2+
3+
[`PortfolioOptimizationBenchmark`](@ref)
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Subset Selection
2+
3+
[`SubsetSelectionBenchmark`](@ref) is a very simple benchmark problem of subset selection.
4+
5+
We have a set of ``n`` items, each item having an `unknown' value.
6+
We want to select a subset of ``k`` items that maximizes the sum of the values of the selected items.
7+
8+
As input, we are given a feature vector, that contains exactly the value of each item.
9+
The goal is to learn the identity mapping between the feature vector and the value of the items.

docs/src/benchmarks/warcraft.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Warcraft
2+
3+
[`WarcraftBenchmark`](@ref)

0 commit comments

Comments
 (0)