robertmartin8 / PyPortfolioOpt

Financial portfolio optimisation in python, including classical efficient frontier, Black-Litterman, Hierarchical Risk Parity
https://pyportfolioopt.readthedocs.io/
MIT License
4.39k stars 940 forks source link

Minor documentation issues #331

Closed SteveDiamond closed 3 years ago

SteveDiamond commented 3 years ago

Describe the bug I found the following minor errors in the documentation:

In the User Guide:

ef = EfficientFrontier(mu, S)
ef.add_objective(objective_functions.L2_reg, gamma=0.1)
w = ef.max_sharpe()
print(ef.clean_weights())

should start with from pypfopt import objective_functions.

In the FAQ "or small problems with ..." should be "For small problems with ...".

robertmartin8 commented 3 years ago

Cheers, fixed!