Skip to content

Commit c1ac9d2

Browse files
committed
Fix docstrings
1 parent b661998 commit c1ac9d2

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

financetoolkit/base/performance/performance_controller.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ def get_beta(
119119
120120
The formula is as follows:
121121
122-
Beta = Covariance of Asset Returns and Benchmark Returns / Variance of Benchmark Returns
122+
- Beta = Covariance of Asset Returns and Benchmark Returns / Variance of Benchmark Returns
123123
124124
For a given period, for example monthly, this translates into the following:
125125
126-
Beta = Monthly Covariance of Asset Returns and Benchmark Returns
126+
- Beta = Monthly Covariance of Asset Returns and Benchmark Returns
127127
/ Monthly Variance of Benchmark Returns
128128
129129
See definition: https://en.wikipedia.org/wiki/Beta_(finance)
@@ -326,7 +326,7 @@ def get_alpha(
326326
327327
The formula is as follows:
328328
329-
Alpha = Asset's Actual Return - Benchmark's Actual Return
329+
- Alpha = Asset's Actual Return - Benchmark's Actual Return
330330
331331
See definition: https://en.wikipedia.org/wiki/Alpha_(finance)
332332
@@ -405,7 +405,7 @@ def get_jensens_alpha(
405405
406406
The formula for Jensen's Alpha is as follows:
407407
408-
Jensen's Alpha = Asset's Actual Return - [Risk-Free Rate + Beta * (Benchmark Return - Risk-Free Rate)]
408+
- Jensen's Alpha = Asset's Actual Return - [Risk-Free Rate + Beta * (Benchmark Return - Risk-Free Rate)]
409409
410410
See definition: https://en.wikipedia.org/wiki/Jensen%27s_alpha
411411
@@ -496,7 +496,7 @@ def get_treynor_ratio(
496496
497497
The formula is as follows:
498498
499-
Treynor Ratio = (Portfolio's Return - Risk-Free Rate) / Portfolio Beta
499+
- Treynor Ratio = (Portfolio's Return - Risk-Free Rate) / Portfolio Beta
500500
501501
See definition: https://en.wikipedia.org/wiki/Treynor_ratio
502502
@@ -586,15 +586,15 @@ def get_sharpe_ratio(
586586
587587
The formula is as follows:
588588
589-
Sharpe Ratio = Excess Return / Excess Standard Deviation
589+
- Sharpe Ratio = Excess Return / Excess Standard Deviation
590590
591591
For a given period, for example monthly, this translates into the following:
592592
593-
Sharpe Ratio = Average Monthly Excess Return / Standard Deviation of Monthly Excess Returns
593+
- Sharpe Ratio = Average Monthly Excess Return / Standard Deviation of Monthly Excess Returns
594594
595595
For a rolling period, this translates into the following:
596596
597-
Sharpe Ratio = Average Rolling Excess Return / Standard Deviation of Rolling Excess Returns
597+
- Sharpe Ratio = Average Rolling Excess Return / Standard Deviation of Rolling Excess Returns
598598
599599
Note that this is explicitly already subtracts the Risk Free Rate.
600600
@@ -680,15 +680,15 @@ def get_sortino_ratio(
680680
681681
The formula is as follows:
682682
683-
Sortino Ratio = Excess Return / Excess Downside Risk
683+
- Sortino Ratio = Excess Return / Excess Downside Risk
684684
685685
For a given period, for example monthly, this translates into the following:
686686
687-
Sortino Ratio = Average Monthly Excess Return / Average Monthly Excess Downside Risk
687+
- Sortino Ratio = Average Monthly Excess Return / Average Monthly Excess Downside Risk
688688
689689
For a rolling period, this translates into the following:
690690
691-
Sortino Ratio = Average Rolling Excess Return / Rolling Downside Risk
691+
- Sortino Ratio = Average Rolling Excess Return / Rolling Downside Risk
692692
693693
Note that this is explicitly already subtracts the Risk Free Rate.
694694
@@ -839,7 +839,7 @@ def get_m2_ratio(
839839
840840
The formula is as follows:
841841
842-
M2 Ratio = (Portfolio's Return - Risk-Free Rate) / Portfolio Standard Deviation
842+
- M2 Ratio = (Portfolio's Return - Risk-Free Rate) / Portfolio Standard Deviation
843843
844844
See definition: https://en.wikipedia.org/wiki/Modigliani_risk-adjusted_performance
845845
@@ -924,7 +924,7 @@ def get_tracking_error(
924924
925925
The formula is as follows:
926926
927-
Tracking Error (TE) = Standard Deviation of (Portfolio Returns - Benchmark Returns)
927+
- Tracking Error (TE) = Standard Deviation of (Portfolio Returns - Benchmark Returns)
928928
929929
See definition: https://en.wikipedia.org/wiki/Tracking_error
930930
@@ -1011,7 +1011,7 @@ def get_information_ratio(
10111011
10121012
The formula is as follows:
10131013
1014-
Information Ratio (IR) = (Portfolio's Excess Return - Benchmark's Excess Return) / Tracking Error
1014+
- Information Ratio (IR) = (Portfolio's Excess Return - Benchmark's Excess Return) / Tracking Error
10151015
10161016
See definition: https://en.wikipedia.org/wiki/Information_ratio
10171017

0 commit comments

Comments
 (0)