Merge pull request #5 from JuliaDecisionFocusedLearning/rename-package

Rename package to DecisionFocusedLearningBenchmarks.jl

Author: BatyLeo

Project.toml

@@ -1,4 +1,4 @@
-name = "InferOptBenchmarks"
+name = "DecisionFocusedLearningBenchmarks"
 uuid = "2fbe496a-299b-4c81-bab5-c44dfc55cf20"
 authors = ["Members of JuliaDecisionFocusedLearning"]
 version = "0.1.0"

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)
+Set of benchmark problems to be solved with [DecisionFocusedLearning.jl](https://github.com/JuliaDecisionFocusedLearning/DecisionFocusedLearning.jl)

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"

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",
 )

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
 ```

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
 ```

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
 ```

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.

src/InferOptBenchmarks.jl renamed to 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

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