Merge pull request #30 from JuliaDecisionFocusedLearning/dynamic-interface-poc

Interface overhaul and new dynamic benchmarks

Author: BatyLeo

Project.toml

@@ -5,6 +5,7 @@ version = "0.2.4"
 
 [deps]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
 ConstrainedShortestPaths = "b3798467-87dc-4d99-943d-35a1bd39e395"
 DataDeps = "124859b0-ceae-595e-8997-d05f6a7a8dfe"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
@@ -13,7 +14,10 @@ Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
+InferOpt = "4846b161-c94e-4150-8dac-c7ae193c601f"
 Ipopt = "b6b21f68-93f8-5de0-b562-5493be1d77c9"
+IterTools = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -31,6 +35,7 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [compat]
 Colors = "0.13.1"
+Combinatorics = "1.0.3"
 ConstrainedShortestPaths = "0.6.0"
 DataDeps = "0.7"
 Distributions = "0.25"
@@ -39,7 +44,10 @@ Flux = "0.14, 0.15, 0.16"
 Graphs = "1.11"
 HiGHS = "1.9"
 Images = "0.26.1"
+InferOpt = "0.7.0"
 Ipopt = "1.6"
+IterTools = "1.10.0"
+JSON = "0.21.4"
 JuMP = "1.22"
 LaTeXStrings = "1.4.0"
 LinearAlgebra = "1"

docs/make.jl

@@ -12,8 +12,8 @@ api_dir = joinpath(@__DIR__, "src", "api")
 api_files = map(x -> joinpath("api", x), readdir(api_dir))
 tutorial_files = readdir(tutorial_dir)
 md_tutorial_files = [split(file, ".")[1] * ".md" for file in tutorial_files]
-benchmark_files = readdir(benchmarks_dir)
-md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]
+benchmark_files = [joinpath("benchmarks", e) for e in readdir(benchmarks_dir)]
+# md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]
 
 include_tutorial = true
 
@@ -25,20 +25,14 @@ if include_tutorial
 end
 
 makedocs(;
-    modules=[DecisionFocusedLearningBenchmarks, DecisionFocusedLearningBenchmarks.Warcraft],
+    modules=[DecisionFocusedLearningBenchmarks],
     authors="Members of JuliaDecisionFocusedLearning",
     sitename="DecisionFocusedLearningBenchmarks.jl",
-    format=Documenter.HTML(),
+    format=Documenter.HTML(; size_threshold=typemax(Int)),
     pages=[
         "Home" => "index.md",
         "Tutorials" => include_tutorial ? md_tutorial_files : [],
-        "Benchmark problems list" => [
-            "benchmarks/subset_selection.md",
-            "benchmarks/fixed_size_shortest_path.md",
-            "benchmarks/warcraft.md",
-            "benchmarks/portfolio_optimization.md",
-            "benchmarks/vsp.md",
-        ],
+        "Benchmark problems list" => benchmark_files,
         "API reference" => api_files,
     ],
 )

docs/src/api/0_interface.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Interface
 
 ## Public

docs/src/api/argmax.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Argmax
 
 ## Public

docs/src/api/argmax_2d.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Argmax2D
 
 ## Public

docs/src/api/dvsp.md

@@ -0,0 +1,19 @@
+```@meta
+CollapsedDocStrings = true
+```
+
+# Dynamic Vehicle Scheduling
+
+## Public
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.DynamicVehicleScheduling]
+Private = false
+```
+
+## Private
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.DynamicVehicleScheduling]
+Public = false
+```

docs/src/api/dynamic_assorment.md

@@ -0,0 +1,19 @@
+```@meta
+CollapsedDocStrings = true
+```
+
+# Dynamic Assortment
+
+## Public
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.DynamicAssortment]
+Private = false
+```
+
+## Private
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.DynamicAssortment]
+Public = false
+```

docs/src/api/fixed_shortest_path.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Fixed-size shortest path
 
 ## Public

docs/src/api/portfolio_optimization.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Subset selection
 
 ## Public

docs/src/api/ranking.md

@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # Ranking
 
 ## Public