Skip to content

Commit

Permalink
docs: improve docs for the EfficientFrontier
Browse files Browse the repository at this point in the history
  • Loading branch information
chilango74 committed Nov 19, 2024
1 parent 7d628cf commit 806f85f
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions okama/frontier/single_period.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ def __init__(
self.labels_are_tickers = ticker_names
self._ef_points = pd.DataFrame(dtype=float)
self._mdp_points = pd.DataFrame(dtype=float)
# TODO: add missing tests (might be problems when no bounds)

def __repr__(self):
dic = {
Expand Down Expand Up @@ -341,8 +342,8 @@ def get_most_diversified_portfolio(
monthly_return: bool = False,
) -> dict:
"""
Calculate assets weights, risk, return and Diversification ratio for the most diversified portfolio given
the target return within given bounds.
Calculate assets weights, annualized values for risk and return, Diversification ratio
for the most diversified portfolio given the target return within given bounds.
The most diversified portfolio has the largest Diversification Ratio.
Expand All @@ -352,7 +353,7 @@ def get_most_diversified_portfolio(
Returns
-------
dict
Weights of assets, risk and return of the most diversified portfolio.
Weights of assets and annualized values for risk, return and CAGR of the most diversified portfolio.
Parameters
----------
Expand Down Expand Up @@ -532,7 +533,7 @@ def minimize_risk(
In Mean-Variance optimization the objective function is risk (standard deviation of return time series).
Optimization returns a "point" on the Efficient Frontier with values:
Optimization returns a "point" on the Efficient Frontier with annualized values:
- weights of assets
- annualized mean rate of return
Expand All @@ -546,7 +547,7 @@ def minimize_risk(
Returns
-------
dict
Point on the Efficient Frontier with assets weights, mean return, CAGR, risk.
Point on the Efficient Frontier with assets weights and annualized values for mean return, CAGR, risk.
Parameters
----------
Expand Down

0 comments on commit 806f85f

Please sign in to comment.