Paper mohamed

.github/workflows/run-example.yml

@@ -6,11 +6,53 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
 jobs:
-  placeholder:
-    runs-on: ubuntu-latest
+  example:
+    name: Run example.jl (${{ matrix.version }} - ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        version: ['1', '1.11.7']
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+
     steps:
-      - name: Placeholder
+      - uses: actions/checkout@v4
+
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.version }}
+
+      - uses: actions/cache@v4
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-example-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-example-${{ env.cache-name }}-
+            ${{ runner.os }}-example-
+            ${{ runner.os }}-
+
+
+      - name: Instantiate example environment
         run: |
-          echo "CompareBenchmarks workflow placeholder"
-          echo "This workflow will be implemented in a future update.":
+          julia --project=paper/examples -e "using Pkg; Pkg.instantiate()"
+
+      - name: Run example.jl
+        run: |
+          julia --project=paper/examples -e '
+          ENV["MLDATASETS_ACCEPT_ALL"]="true";
+          ENV["DATADEPS_ALWAYS_ACCEPT"]="true";
+          include("paper/examples/example.jl")
+          '
+
+      - name: Run benchmark.jl
+        run: |
+          julia --project=paper/examples -e '
+          ENV["MLDATASETS_ACCEPT_ALL"]="true";
+          ENV["DATADEPS_ALWAYS_ACCEPT"]="true";
+          include("paper/examples/Benchmark.jl");
+          main()
+          '
 

CITATION.bib

@@ -1,5 +1,5 @@
-@Misc{baraldi-leconte-orban-regularized-optimization-2024,
-  author = {R. Baraldi and G. Leconte and D. Orban},
+@Misc{baraldi-diouane-gollier-habiboullah-leconte-orban-regularized-optimization-2024,
+  author = {R. Baraldi and Y. Diouane and M. Gollier and M. L. Habiboullah and G. Leconte and D. Orban},
   title = {{RegularizedOptimization.jl}: Algorithms for Regularized Optimization},
   month = {September},
   howpublished = {\url{https://github.com/JuliaSmoothOptimizers/RegularizedOptimization.jl}},

Project.toml

@@ -1,6 +1,11 @@
 name = "RegularizedOptimization"
-uuid = "196f2941-2d58-45ba-9f13-43a2532b2fa8"
-author = ["Robert Baraldi <rbaraldi@uw.edu> and Dominique Orban <dominique.orban@gmail.com>"]
+uuid = "20620ad1-4fe4-4467-ae46-fb087718fe7b"
+author = ["Robert Baraldi <rbaraldi@uw.edu>", 
+          "Youssef Diouane <youssef.diouane@polymtl.ca>",
+          "Maxence Gollier <maxence-2.gollier@polymtl.ca>",
+          "Mohamed Laghdaf Habiboullah <mohamed-laghdaf-2.habiboullah@polymtl.ca>",
+          "Geoffroy Leconte <geoffroy.leconte@polymtl.ca>",
+          "Dominique Orban <dominique.orban@gmail.com>"]
 version = "0.1.0"
 
 [deps]

paper/examples/Project.toml

@@ -1,7 +1,12 @@
 [deps]
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
 NLPModels = "a4795742-8479-5a88-8948-cc11e1c8c1a6"
 NLPModelsModifiers = "e01155f1-5c6f-4375-a9d8-616dd036575f"
 PrettyTables = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"
+RegularizedOptimization = "196f2941-2d58-45ba-9f13-43a2532b2fa8"
 RegularizedProblems = "ea076b23-609f-44d2-bb12-a4ae45328278"
 ShiftedProximalOperators = "d4fd37fa-580c-4e43-9b30-361c21aae263"
+
+[sources]
+RegularizedOptimization = {path = "../.."}

src/RegularizedOptimization.jl

@@ -16,6 +16,8 @@ using LinearOperators,
   SolverCore
 using Percival: AugLagModel, update_y!, update_μ!
 
+import SolverCore.reset!
+
 const callback_docstring = "
 The callback is called at each iteration.
 The expected signature of the callback is `callback(nlp, solver, stats)`, and its output is ignored.

test/test_allocs.jl

@@ -33,6 +33,7 @@ macro wrappedallocs(expr)
   kwargs_dict = Dict{Symbol, Any}(a.args[1] => a.args[2] for a in kwargs if a.head == :kw)
   quote
     function g($(argnames...); kwargs_dict...)
+      $(Expr(expr.head, argnames..., kwargs...)) # Call the function twice to make the allocated macro more stable
       @allocated $(Expr(expr.head, argnames..., kwargs...))
     end
     $(Expr(:call, :g, [esc(a) for a in args]...))