alihan/PyPortfolioOpt
1
0
Fork 0
mirror of https://github.com/robertmartin8/PyPortfolioOpt.git synced 2022-11-27 18:02:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

reorganised docs

Browse Source
This commit is contained in:
robertmartin8
2021-02-19 13:38:36 +08:00
parent 72b8bdbb55
commit 746ababafe
15 changed files with 484 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pypfopt/base_optimizer.py
View File

@@ -135,7 +135,7 @@ class BaseConvexOptimizer(BaseOptimizer):
Public methods:
- ``add_objective()`` adds a (convex) objective to the optimisation problem
- ``add_constraint()`` adds a (linear) constraint to the optimisation problem
- ``add_constraint()`` adds a constraint to the optimisation problem
- ``convex_objective()`` solves for a generic convex objective with linear constraints
- ``nonconvex_objective()`` solves for a generic nonconvex objective using the scipy backend.
This is prone to getting stuck in local minima and is generally *not* recommended.
@@ -266,8 +266,8 @@ class BaseConvexOptimizer(BaseOptimizer):
def add_constraint(self, new_constraint):
"""
Add a new constraint to the optimisation problem. This constraint must be linear and
must be either an equality or simple inequality.
Add a new constraint to the optimisation problem. This constraint must satisfy DCP rules,
i.e be either a linear equality constraint or convex inequality constraint.
Examples::