diff --git a/Project.toml b/Project.toml index d2c071d..c6588f0 100644 --- a/Project.toml +++ b/Project.toml @@ -1,4 +1,4 @@ -name = "InferOptBenchmarks" +name = "DecisionFocusedLearningBenchmarks" uuid = "2fbe496a-299b-4c81-bab5-c44dfc55cf20" authors = ["Members of JuliaDecisionFocusedLearning"] version = "0.1.0" diff --git a/README.md b/README.md index 52bb13b..6634d85 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# InferOptBenchmarks.jl +# DecisionFocusedLearningBenchmarks.jl -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaDecisionFocusedLearning.github.io/InferOptBenchmarks.jl/dev/) -[![Build Status](https://github.com/JuliaDecisionFocusedLearning/InferOptBenchmarks.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/JuliaDecisionFocusedLearning/InferOptBenchmarks.jl/actions/workflows/Test.yml?query=branch%3Amain) -[![Coverage](https://codecov.io/gh/JuliaDecisionFocusedLearning/InferOptBenchmarks.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/JuliaDecisionFocusedLearning/InferOptBenchmarks.jl) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaDecisionFocusedLearning.github.io/DecisionFocusedLearningBenchmarks.jl/dev/) +[![Build Status](https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/actions/workflows/Test.yml?query=branch%3Amain) +[![Coverage](https://codecov.io/gh/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/JuliaDiff/BlueStyle) -Set of benchmark problems to be solved with [InferOpt.jl](https://github.com/JuliaDecisionFocusedLearning/InferOpt.jl) \ No newline at end of file +Set of benchmark problems to be solved with [DecisionFocusedLearning.jl](https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearning.jl) diff --git a/docs/Project.toml b/docs/Project.toml index cdba247..dff3a26 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,6 +2,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c" InferOpt = "4846b161-c94e-4150-8dac-c7ae193c601f" -InferOptBenchmarks = "2fbe496a-299b-4c81-bab5-c44dfc55cf20" +DecisionFocusedLearningBenchmarks = "2fbe496a-299b-4c81-bab5-c44dfc55cf20" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" diff --git a/docs/make.jl b/docs/make.jl index 0dd94a1..6a818c8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,5 @@ using Documenter -using InferOptBenchmarks +using DecisionFocusedLearningBenchmarks using Literate cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md"); force=true) @@ -15,9 +15,9 @@ for file in tutorial_files end makedocs(; - modules=[InferOptBenchmarks, InferOptBenchmarks.Warcraft], + modules=[DecisionFocusedLearningBenchmarks, DecisionFocusedLearningBenchmarks.Warcraft], authors="Members of JuliaDecisionFocusedLearning", - sitename="InferOptBenchmarks.jl", + sitename="DecisionFocusedLearningBenchmarks.jl", format=Documenter.HTML(), pages=[ "Home" => "index.md", @@ -33,5 +33,6 @@ for file in md_tutorial_files end deploydocs(; - repo="github.com/JuliaDecisionFocusedLearning/InferOptBenchmarks.jl", devbranch="main" + repo="github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearningBenchmarks.jl", + devbranch="main", ) diff --git a/docs/src/api/decision_focused.md b/docs/src/api/decision_focused.md index ff632e2..a41f439 100644 --- a/docs/src/api/decision_focused.md +++ b/docs/src/api/decision_focused.md @@ -3,13 +3,13 @@ ## Public ```@autodocs -Modules = [InferOptBenchmarks.FixedSizeShortestPath, InferOptBenchmarks.PortfolioOptimization, InferOptBenchmarks.SubsetSelection] +Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath, DecisionFocusedLearningBenchmarks.PortfolioOptimization, DecisionFocusedLearningBenchmarks.SubsetSelection] Private = false ``` ## Private ```@autodocs -Modules = [InferOptBenchmarks.FixedSizeShortestPath, InferOptBenchmarks.PortfolioOptimization, InferOptBenchmarks.SubsetSelection] +Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath, DecisionFocusedLearningBenchmarks.PortfolioOptimization, DecisionFocusedLearningBenchmarks.SubsetSelection] Public = false ``` diff --git a/docs/src/api/interface.md b/docs/src/api/interface.md index f161761..1b0a22c 100644 --- a/docs/src/api/interface.md +++ b/docs/src/api/interface.md @@ -3,13 +3,13 @@ ## Public ```@autodocs -Modules = [InferOptBenchmarks.Utils] +Modules = [DecisionFocusedLearningBenchmarks.Utils] Private = false ``` ## Private ```@autodocs -Modules = [InferOptBenchmarks.Utils] +Modules = [DecisionFocusedLearningBenchmarks.Utils] Public = false ``` diff --git a/docs/src/api/warcraft.md b/docs/src/api/warcraft.md index a6199d2..3ff6824 100644 --- a/docs/src/api/warcraft.md +++ b/docs/src/api/warcraft.md @@ -3,13 +3,13 @@ ## Public ```@autodocs -Modules = [InferOptBenchmarks.Warcraft] +Modules = [DecisionFocusedLearningBenchmarks.Warcraft] Private = false ``` ## Private ```@autodocs -Modules = [InferOptBenchmarks.Warcraft] +Modules = [DecisionFocusedLearningBenchmarks.Warcraft] Public = false ``` diff --git a/docs/src/tutorials/warcraft.jl b/docs/src/tutorials/warcraft.jl index 12d5818..9b6d199 100644 --- a/docs/src/tutorials/warcraft.jl +++ b/docs/src/tutorials/warcraft.jl @@ -1,13 +1,13 @@ # # Path-finding on image maps #= -In this tutorial, we showcase InferOptBenchmarks.jl capabilities on one of its main benchmarks: the Warcraft benchmark. +In this tutorial, we showcase DecisionFocusedLearningBenchmarks.jl capabilities on one of its main benchmarks: the Warcraft benchmark. This benchmark problem is a simple path-finding problem where the goal is to find the shortest path between the top left and bottom right corners of a given image map. The map is represented as a 2D image representing a 12x12 grid, each cell having an unknown travel cost depending on the terrain type. =# # First, let's load the package and create a benchmark object as follows: -using InferOptBenchmarks +using DecisionFocusedLearningBenchmarks b = WarcraftBenchmark() # ## Dataset generation @@ -38,7 +38,7 @@ plot_data(b, sample) # ## Building a pipeline -# InferOptBenchmarks also provides methods to build an hybrid machine learning and combinatorial optimization pipeline for the benchmark. +# DecisionFocusedLearningBenchmarks also provides methods to build an hybrid machine learning and combinatorial optimization pipeline for the benchmark. # First, the [`generate_statistical_model`](@ref) method generates a machine learning predictor to predict cell weights from the input image: model = generate_statistical_model(b) # In the case of the Warcraft benchmark, the model is a convolutional neural network built using the Flux.jl package. diff --git a/src/InferOptBenchmarks.jl b/src/DecisionFocusedLearningBenchmarks.jl similarity index 92% rename from src/InferOptBenchmarks.jl rename to src/DecisionFocusedLearningBenchmarks.jl index 0846845..071a15c 100644 --- a/src/InferOptBenchmarks.jl +++ b/src/DecisionFocusedLearningBenchmarks.jl @@ -1,4 +1,4 @@ -module InferOptBenchmarks +module DecisionFocusedLearningBenchmarks using DataDeps using HiGHS @@ -44,4 +44,4 @@ export FixedSizeShortestPathBenchmark export PortfolioOptimizationBenchmark export SubsetSelectionBenchmark -end # module InferOptBenchmarks +end # module DecisionFocusedLearningBenchmarks diff --git a/test/code.jl b/test/code.jl index c2f2f87..cd2fb64 100644 --- a/test/code.jl +++ b/test/code.jl @@ -1,19 +1,23 @@ @testitem "Aqua" begin using Aqua - Aqua.test_all(InferOptBenchmarks; ambiguities=false, deps_compat=(check_extras = false)) + Aqua.test_all( + DecisionFocusedLearningBenchmarks; + ambiguities=false, + deps_compat=(check_extras = false), + ) end @testitem "JET" begin using JET - JET.test_package(InferOptBenchmarks; target_defined_modules=true) + JET.test_package(DecisionFocusedLearningBenchmarks; target_defined_modules=true) end @testitem "JuliaFormatter" begin using JuliaFormatter - JuliaFormatter.format(InferOptBenchmarks; verbose=false, overwrite=false) + JuliaFormatter.format(DecisionFocusedLearningBenchmarks; verbose=false, overwrite=false) end @testitem "Documenter" begin using Documenter - Documenter.doctest(InferOptBenchmarks) + Documenter.doctest(DecisionFocusedLearningBenchmarks) end diff --git a/test/fixed_size_shortest_path.jl b/test/fixed_size_shortest_path.jl index 3173480..422e9e8 100644 --- a/test/fixed_size_shortest_path.jl +++ b/test/fixed_size_shortest_path.jl @@ -1,6 +1,6 @@ module FixedSizeShortestPathTest -using InferOptBenchmarks.FixedSizeShortestPath +using DecisionFocusedLearningBenchmarks.FixedSizeShortestPath # using Flux # using InferOpt diff --git a/test/portfolio_optimization.jl b/test/portfolio_optimization.jl index 573d341..54ffb83 100644 --- a/test/portfolio_optimization.jl +++ b/test/portfolio_optimization.jl @@ -1,5 +1,5 @@ @testitem "Portfolio Optimization" begin - using InferOptBenchmarks + using DecisionFocusedLearningBenchmarks using InferOpt using Flux using Zygote diff --git a/test/subset_selection.jl b/test/subset_selection.jl index 96ee5eb..5e8ba95 100644 --- a/test/subset_selection.jl +++ b/test/subset_selection.jl @@ -1,5 +1,5 @@ @testitem "Subset selection" begin - using InferOptBenchmarks + using DecisionFocusedLearningBenchmarks using InferOpt using Flux using UnicodePlots diff --git a/test/utils.jl b/test/utils.jl index e6b35ac..b071bd8 100644 --- a/test/utils.jl +++ b/test/utils.jl @@ -1,6 +1,6 @@ @testitem "Grid graphs" begin - using InferOptBenchmarks.Utils - using InferOptBenchmarks.Utils: count_edges, get_path, index_to_coord + using DecisionFocusedLearningBenchmarks.Utils + using DecisionFocusedLearningBenchmarks.Utils: count_edges, get_path, index_to_coord using Graphs h = 4 diff --git a/test/warcraft.jl b/test/warcraft.jl index ff55012..cc9f9c2 100644 --- a/test/warcraft.jl +++ b/test/warcraft.jl @@ -1,6 +1,6 @@ @testitem "Warcraft" begin - using InferOptBenchmarks - using InferOptBenchmarks.Utils: objective_value + using DecisionFocusedLearningBenchmarks + using DecisionFocusedLearningBenchmarks.Utils: objective_value b = WarcraftBenchmark()