doc: prepare for v0.9.0

PyLops · Aug 16, 2024 · bbe9478 · bbe9478
1 parent 9d89680
commit bbe9478
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+Changelog
+=========
+
+# 0.9.0
+
+* Added :py:class:`pyproximal.optimization.palm.iPALM` solver
+* Added :py:func:`pyproximal.optimization.palm._backtracking` method to be used when `gammaf=None` and/or `gammag=None`
+* Added :py:func:`pyproximal.utils.gradtest.gradtest_proximal` and :py:func:`pyproximal.utils.gradtest.gradtest_bilinear` methods
+* Added `tol` to :py:class:`pyproximal.optimization.primal.ProximalPoint` and
+  :py:class:`pyproximal.optimization.primal.ProximalGradient` solvers
+* Modified :py:class:`pyproximal.ProxOperator.precomposition` to allow `b` being also a vector
+
+
 # 0.8.0
 
 * Added ``pyproximal.projection.L01BallProj`` and ``pyproximal.proximal.L01Ball`` operators

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -3,6 +3,18 @@
 Changelog
 =========
 
+Version 0.9.0
+--------------
+*Released on: 16/08/2024*
+
+* Added :py:class:`pyproximal.optimization.palm.iPALM` solver
+* Added :py:func:`pyproximal.optimization.palm._backtracking` method to be used when `gammaf=None` and/or `gammag=None`
+* Added :py:func:`pyproximal.utils.gradtest.gradtest_proximal` and :py:func:`pyproximal.utils.gradtest.gradtest_bilinear` methods
+* Added `tol` to :py:class:`pyproximal.optimization.primal.ProximalPoint` and
+  :py:class:`pyproximal.optimization.primal.ProximalGradient` solvers
+* Modified :py:class:`pyproximal.ProxOperator.precomposition` to allow `b` being also a vector
+
+
 Version 0.8.0
 --------------
 *Released on: 11/03/2024*

diff --git a/pyproximal/ProxOperator.py b/pyproximal/ProxOperator.py
@@ -202,8 +202,8 @@ def precomposition(self, a, b):
         ----------
         a : :obj:`float`
             Multiplicative scalar
-        b : :obj:`float`
-            Additive Scalar
+        b : :obj:`float` or obj:`np.ndarray`
+            Additive scalar (or vector)
 
         Notes
         -----