Merge branch 'master' into jg/diff2

.github/workflows/TagBot.yml

@@ -1,17 +1,15 @@
 name: TagBot
 on:
-  issue_comment:  # THIS BIT IS NEW
+  issue_comment:
     types:
       - created
   workflow_dispatch:
 jobs:
   TagBot:
-    # THIS 'if' LINE IS NEW
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
-    # NOTHING BELOW HAS CHANGED
     runs-on: ubuntu-latest
     steps:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/ci.yml

@@ -22,24 +22,16 @@ jobs:
             os: ubuntu-latest
             arch: x86
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v1
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v4
         with:
-          file: lcov.info
+          file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/documentation.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
           # Build documentation on Julia 1.6
@@ -20,4 +20,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-        run: julia --project=docs/ docs/make.jl
+        run: julia --color=yes --project=docs/ docs/make.jl

.github/workflows/format_check.yml

@@ -13,12 +13,12 @@ jobs:
       - uses: julia-actions/setup-julia@latest
         with:
           version: '1'
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Format check
         shell: julia --color=yes {0}
         run: |
           using Pkg
-          Pkg.add(PackageSpec(name="JuliaFormatter", version="0.22.2"))
+          Pkg.add(PackageSpec(name="JuliaFormatter", version="1"))
           using JuliaFormatter
           format("src", verbose=true)
           format("test", verbose=true)

Project.toml

@@ -1,7 +1,7 @@
 name = "ParametricOptInterface"
 uuid = "0ce4ce61-57bf-432b-a095-efac525d185e"
 authors = ["Tomás Gutierrez <[email protected]>"]
-version = "0.7.0"
+version = "0.8.2"
 
 [deps]
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"

docs/src/Examples/example.md

@@ -353,7 +353,7 @@ MOI.set(
 )
 ```
 
-To multiply a parameter in a quadratic term, the user will 
+To multiply a parameter in a quadratic term, the user will
 need to use the `POI.QuadraticObjectiveCoef` model attribute.
 
 ```@example moi2
@@ -415,7 +415,7 @@ We use the same MOI function to add the parameter multiplied to the quadratic te
 MOI.set(backend(model), POI.QuadraticObjectiveCoef(), (index(x),index(y)), 2index(p)+3)
 ```
 
-If the user print the `model`, the term `(2p+3)*xy` won't show. 
+If the user print the `model`, the term `(2p+3)*xy` won't show.
 It's possible to retrieve the parametric function multiplying the term `xy` with `MOI.get`.
 
 ```@example jump4
@@ -440,63 +440,3 @@ isapprox(objective_value(model), 128/9, atol=1e-4)
 isapprox(value(x), 4/3, atol=1e-4)
 isapprox(value(y), 4/3, atol=1e-4)
 ```
-## JuMP Example - Non Linear Programming (NLP)
-
-POI currently works with NLPs when users wish to add the parameters to the non-NL constraints or objective. This means that POI works with models like this one:
-
-```julia
-@variable(model, x)
-@variable(model, y)
-@variable(model, z in MOI.Parameter(10))
-@constraint(model, x + y >= z)
-@NLobjective(model, Min, x^2 + y^2)
-```
-
-but does not work with models that have parameters on the NL expressions like this one:
-
-```julia
-@variable(model, x)
-@variable(model, y)
-@variable(model, z in MOI.Parameter(10))
-@constraint(model, x + y >= z)
-@NLobjective(model, Min, x^2 + y^2 + z) # There is a parameter here
-```
-
-If users with to add parameters in NL expressions we strongly recommend them to read [this section on the JuMP documentation]((https://jump.dev/JuMP.jl/stable/manual/nlp/#Create-a-nonlinear-parameter))
-
-Although POI works with NLPs there are some important information for users to keep in mind. All come from the fact that POI relies on the MOI interface for problem modifications and these are not common on NLP solvers, most solvers only allow users to modify variable bounds using their official APIs. This means that if users wish to make modifications on some constraint that is not a variable bound we are not allowed to call `MOI.modify` because the function is not supported in the MOI solver interface. The work-around to this is defining a [`POI.Optimizer`](@ref) on a caching optimizer:
-
-```julia
-ipopt = Ipopt.Optimizer()
-MOI.set(ipopt, MOI.RawOptimizerAttribute("print_level"), 0)
-cached =
-    () -> MOI.Bridges.full_bridge_optimizer(
-        MOIU.CachingOptimizer(
-            MOIU.UniversalFallback(MOIU.Model{Float64}()),
-            ipopt,
-        ),
-        Float64,
-    )
-POI_cached_optimizer() = POI.Optimizer(cached())
-model = Model(() -> POI_cached_optimizer())
-@variable(model, x)
-@variable(model, y)
-@variable(model, z in MOI.Parameter(10))
-@constraint(model, x + y >= z)
-@NLobjective(model, Min, x^2 + y^2)
-```
-
-This works but keep in mind that the model has an additional layer of between the solver and the [`POI.Optimizer`](@ref). This will make most operations slower than with the version without the caching optimizer. Keep in mind that since the official APIs of most solvers don't allow for modifications on linear constraints there should have no big difference between making a modification using POI or re-building the model from scratch.
-
-If users wish to make modifications on variable bounds the POI interface will help you save time between solves. In this case you should use the [`ParametricOptInterface.ConstraintsInterpretation`](@ref) as we do in this example:
-
-```julia
-model = Model(() -> POI.Optimizer(Ipopt.Optimizer()))
-@variable(model, x)
-@variable(model, z in MOI.Parameter(10))
-MOI.set(model, POI.ConstraintsInterpretation(), POI.ONLY_BOUNDS)
-@constraint(model, x >= z)
-@NLobjective(model, Min, x^2)
-```
-
-This use case should help users diminsh the time of making model modifications and re-solve the model. To increase the performance users that are familiar with [JuMP direct mode](https://jump.dev/JuMP.jl/stable/manual/models/#Direct-mode) can also use it.