Skip to content

Commit

Permalink
improved docs on risk_free_rate (robertmartin8#574)
Browse files Browse the repository at this point in the history
  • Loading branch information
robertmartin8 authored and codez0mb1e committed Dec 22, 2024
1 parent b2845d0 commit 751683f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
4 changes: 1 addition & 3 deletions pypfopt/black_litterman.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ def market_implied_risk_aversion(market_prices, frequency=252, risk_free_rate=0.
:param frequency: number of time periods in a year, defaults to 252 (the number
of trading days in a year)
:type frequency: int, optional
:param risk_free_rate: risk-free rate of borrowing/lending, defaults to 0.0.
The period of the risk-free rate should correspond to the
frequency of expected returns.
:param risk_free_rate: annualised risk-free rate of borrowing/lending, defaults to 0.0.
:type risk_free_rate: float, optional
:raises TypeError: if market_prices cannot be parsed
:return: market-implied risk aversion
Expand Down
2 changes: 1 addition & 1 deletion pypfopt/risk_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def semicovariance(
:type benchmark: float
:param frequency: number of time periods in a year, defaults to 252 (the number
of trading days in a year). Ensure that you use the appropriate
benchmark, e.g if ``frequency=12`` use the monthly risk-free rate.
benchmark, e.g if ``frequency=12`` use monthly benchmark returns
:type frequency: int, optional
:param log_returns: whether to compute using log returns
:type log_returns: bool, defaults to False
Expand Down

0 comments on commit 751683f

Please sign in to comment.