From 08703f8980c720a57b5e531f07356183d6e587c6 Mon Sep 17 00:00:00 2001 From: Lorenzo Stella Date: Sun, 20 Mar 2022 12:09:00 +0100 Subject: [PATCH] Update README.md --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e7ec459..f2cd0ee 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ Implemented algorithms include: * Primal-dual splitting algorithms * Newton-type methods +This package works well in combination with [ProximalOperators](https://github.com/JuliaFirstOrder/ProximalOperators.jl) (>= 0.15), +which contains a wide range of functions that can be used to express cost terms. + ## Documentation [Stable version](https://juliafirstorder.github.io/ProximalAlgorithms.jl/stable) (latest release) @@ -30,8 +33,3 @@ Please check [this section of the manual](https://juliafirstorder.github.io/Prox ## Contributing Contributions are welcome in the form of [issues notification](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl/issues) or [pull requests](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl/pulls). We recommend looking at already implemented algorithms to get inspiration on how to structure new ones. - -## Related packages - -This package can be used in combination with [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl) (providing first-order primitives, i.e. gradient and proximal mapping, for numerous cost functions) and [AbstractOperators.jl](https://github.com/kul-forbes/AbstractOperators.jl) (providing several linear and nonlinear operators) to formulate and solve a wide spectrum of nonsmooth optimization problems. -[StructuredOptimization.jl](https://github.com/JuliaFirstOrder/StructuredOptimization.jl) provides a higher-level interface to formulate and solve problems using (some of) the algorithms here included.