Skip to content

Commit 8482ffd

Browse files
committed
Update whatsnew doc section
1 parent e3c9b08 commit 8482ffd

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

docs/source/whatsnew/0.1.0.rst

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,45 @@
11
What's new in PEPit 0.1.0
22
=========================
33

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.
4+
- Adding general constraints to your problem.
85

9-
- CVXPY solver options can be provided to the method ``PEP.solve``.
6+
| The method ``add_constraint`` has been added to the class ``PEP`` for general constraints not necessarily related to a specific function.
7+
| For readability of your code,
8+
we suggest to use the method ``set_initial_condition`` when the constraint is the initial one,
9+
and the method ``add_constraint`` for any other constraint.
1010
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.
11+
- Adding LMI constraints to your problem.
1312

14-
- The verbose mode of the method ``PEP.solve`` and of the provided examples files are now integers, allowing a bigger granularity.
13+
The method ``add_psd_matrix`` has been added to the class ``PEP`` and must be used to add LMI constraints to your problem.
1514

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.)`
15+
- CVXPY options.
1816

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.
17+
| PEPit uses CVXPY to solve the underlying SDP of your problem.
18+
| CVXPY solver options can be provided to the method ``PEP.solve``.
19+
20+
- Optimizing dimension of the solution.
21+
22+
| The ``tracetrick`` option of the method ``PEP.solve`` has been replaced by ``dimension_reduction_heuristic``.
23+
| Set to None by default, this option can be set to "`trace`" or "`logdet{followed by a number}`" to use one of those heuristic.
24+
25+
- Granularity of the verbose mode has evolved.
26+
27+
| The verbose mode of the method ``PEP.solve`` and of the provided examples files are now integers:
28+
- 0: No verbose at all
29+
- 1: PEPit information is printed but not CVXPY's
30+
- 2: Both PEPit and CVXPY details are printed
31+
32+
- Parameters of function classes.
33+
34+
| The parameters that characterize a function class must be provided directly as arguments of this function class, not through the dict "param" anymore.
35+
| Example: ``PEP.declare_function(function_class=SmoothStronglyConvexFunction, mu=.1, L=1.)``
36+
37+
- Initializing a Point or an Expression to 0.
38+
39+
``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.
2040

2141
- 3 new function classes have been added:
42+
2243
- ``ConvexSupportFunction`` for convex support functions (see [1])
2344
- ``ConvexQGFunction``, for convex and quadratically upper bounded functions (see [2])
2445
- ``RsiEbFunction``, for functions verifying lower restricted secant inequality and upper error bound (see [3])

0 commit comments

Comments
 (0)