Skip to content

Commit d4755d4

Browse files
remove regularizers
1 parent 8c8947b commit d4755d4

File tree

6 files changed

+3
-139
lines changed

6 files changed

+3
-139
lines changed

docs/make.jl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ makedocs(
1717
pages = [
1818
"Home" => "index.md",
1919
"Algorithms" => "algorithms.md",
20-
"Regularizers" => "regularizers.md",
2120
"Examples" => [
2221
joinpath("examples", "basic.md"),
2322
joinpath("examples", "ls.md"),
24-
joinpath("examples", "custom_regularizer.md")
2523
],
2624
"Reference" => "reference.md",
2725
"Bibliography" => "bibliography.md"

docs/src/examples/basic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ h(x_1, x_2) &:= \|x\|_1.
2727
\end{align*}
2828
```
2929
To model $f$, we are going to use [ADNLPModels.jl](https://github.com/JuliaSmoothOptimizers/ADNLPModels.jl).
30-
For the nonsmooth regularizer, we observe that $h$ is actually readily available in [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl), you can refer to [this section](@ref regularizers) for a list of readily available regularizers.
30+
For the nonsmooth regularizer, we use [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl).
3131
We then wrap the smooth function and the regularizer in a `RegularizedNLPModel`
3232

3333
```@example basic

docs/src/examples/custom_regularizer.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

docs/src/examples/ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ h(x) &:= \lambda\|x\|_0.
2020
```
2121

2222
To model $f$, we are going to use [ADNLPModels.jl](https://github.com/JuliaSmoothOptimizers/ADNLPModels.jl).
23-
For the nonsmooth regularizer, we observe that $h$ is actually readily available in [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl), you can refer to [this section](@ref regularizers) for a list of readily available regularizers.
23+
For the nonsmooth regularizer, we use [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl).
2424
We then wrap the smooth function and the regularizer in a `RegularizedNLPModel`.
2525

2626
```@example ls

docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ For the smooth component `f`, we refer to [jso.dev](https://jso.dev) for tutoria
2525
- models defined with automatic differentiation ([ADNLPModels.jl](https://github.com/JuliaSmoothOptimizers/ADNLPModels.jl)).
2626
We refer to [ManualNLPModels.jl](https://github.com/JuliaSmoothOptimizers/ManualNLPModels.jl) for users interested in defining their own model.
2727

28+
For the nonsmooth component `h` we refer to [ShiftedProximalOperators.jl](https://github.com/JuliaSmoothOptimizers/ShiftedProximalOperators.jl).
2829
---
2930

3031
## How to Install

docs/src/regularizers.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)