Skip to content

Commit e3c9b08

Browse files
committed
Prepare whatsnew and setup.py files for release 0.1.0
1 parent 57f925b commit e3c9b08

File tree

4 files changed

+40
-30
lines changed

4 files changed

+40
-30
lines changed

docs/source/whatsnew.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ What's new in PEPit
66
:maxdepth: 2
77
:caption: Contents:
88

9-
whatsnew/0.0.3
9+
whatsnew/0.1.0

docs/source/whatsnew/0.0.3.rst

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

docs/source/whatsnew/0.1.0.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
What's new in PEPit 0.1.0
2+
=========================
3+
4+
- The method ``add_constraint`` has been added to the class ``PEP`` for general constraints not necessarily related to a specific function.
5+
For readability of your code,
6+
we suggest to use the method ``set_initial_condition`` when the constraint is the initial one,
7+
and the method ``add_constraint`` for any other constraint.
8+
9+
- CVXPY solver options can be provided to the method ``PEP.solve``.
10+
11+
- The `tracetrick` option of the method ``PEP.solve`` has been replaced by `dimension_reduction_heuristic`.
12+
Set to None by default, this option can be set to "trace" or "logdet{followed by a number}" to use one of those heuristic.
13+
14+
- The verbose mode of the method ``PEP.solve`` and of the provided examples files are now integers, allowing a bigger granularity.
15+
16+
- The parameters that characterize a function class must be provided directly as arguments of this function class, not through the dict "param" anymore.
17+
Example: `PEP.declare_function(function_class=SmoothStronglyConvexFunction, mu=.1, L=1.)`
18+
19+
- ``null_point`` and ``null_expression`` have been added to the module ``PEPit`` to facilitate the access to a ``Point`` or an ``Expression`` initialized to 0.
20+
21+
- 3 new function classes have been added:
22+
- ``ConvexSupportFunction`` for convex support functions (see [1])
23+
- ``ConvexQGFunction``, for convex and quadratically upper bounded functions (see [2])
24+
- ``RsiEbFunction``, for functions verifying lower restricted secant inequality and upper error bound (see [3])
25+
26+
`[1] A. Taylor, J. Hendrickx, F. Glineur (2017).
27+
Exact worst-case performance of first-order methods for composite convex optimization.
28+
SIAM Journal on Optimization, 27(3):1283–1313.
29+
<https://arxiv.org/pdf/1512.07516.pdf>`_
30+
31+
`[2] B. Goujaud, A. Taylor, A. Dieuleveut (2022).
32+
Optimal first-order methods for convex functions with a quadratic upper bound.
33+
<https://arxiv.org/pdf/2205.15033.pdf>`_
34+
35+
`[3] C. Guille-Escuret, B. Goujaud, A. Ibrahim, I. Mitliagkas (2022).
36+
Gradient Descent Is Optimal Under Lower Restricted Secant Inequality And Upper Error Bound.
37+
arXiv 2203.00342.
38+
<https://arxiv.org/pdf/2203.00342.pdf>`_

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
with open("README.md", "r", encoding="utf-8") as fh:
44
long_description = fh.read()
55

6-
version = "0.0.3a1"
6+
version = "0.1.0"
77

88
setuptools.setup(
99
name="PEPit",

0 commit comments

Comments
 (0)