Skip to main content

maxret

Maximizes the portfolio's return

Usage

maxret [-tr TARGET_RETURN] [-tk TARGET_RISK] [-m {hist,ewma1,ewma2}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME]

Parameters

NameParameterDescriptionDefaultOptionalChoices
target_return-tr --target-returnConstraint on minimum level of portfolio's return-1TrueNone
target_risk-tk --target-riskConstraint on maximum level of portfolio's risk-1TrueNone
expected_return-m --meanMethod used to estimate the expected return vectorhistTruehist, ewma1, ewma2
covariance-cv --covarianceMethod used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage methodhistTruehist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink
smoothing_factor_ewma-de --d-ewmaSmoothing factor for ewma estimators0.94TrueNone
short_allocation-vs --value-shortAmount to allocate to portfolio in short positions0.0TrueNone
risk_measure-rm --risk-measureRisk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returnsMVTrueMV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD
nan_fill_method-mt --methodMethod used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all pointstimeTruelinear, time, nearest, zero, slinear, quadratic, cubic, barycentric
categories-ct --categoriesShow selected categoriesTrueNone
historic_period-p --periodPeriod to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset3yTrue1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 3y, 5y, 10y, ytd, max
start_period-s --startStart date to get yfinance data from. Must be in 'YYYY-MM-DD' formatTrueNone
end_period-e --endEnd date to get yfinance data from. Must be in 'YYYY-MM-DD' formatTrueNone
log_returns-lr --log-returnsIf use logarithmic or arithmetic returns to calculate returnsFalseTrueNone
return_frequency--freqFrequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returnsdTrued, w, m
max_nan-mn --maxnanMax percentage of nan values accepted per asset to be considered in the optimization process0.05TrueNone
threshold_value-th --thresholdValue used to replace outliers that are higher to threshold in absolute value0.3TrueNone
risk_free-r --risk-free-rateRisk-free rate of borrowing/lending. The period of the risk-free rate must be annual0.04739TrueNone
significance_level-a --alphaSignificance level of CVaR, EVaR, CDaR and EDaR0.05TrueNone
long_allocation-v --valueAmount to allocate to portfolio1TrueNone
name--nameSave portfolio with personalized or default nameMAXRET_0TrueNone

Examples

[3 Years] Maximal return portfolio using
volatility as risk measure

Weights
┏━━━━━━┳━━━━━━━━━┓
┃ ┃ Value ┃
┡━━━━━━╇━━━━━━━━━┩
│ AAPL │ 0.0 %
├──────┼─────────┤
│ AMZN │ 0.0 %
├──────┼─────────┤
│ BA │ 0.0 %
├──────┼─────────┤
│ FB │ 0.0 %
├──────┼─────────┤
│ MSFT │ 0.0 %
├──────┼─────────┤
│ T │ 0.0 %
├──────┼─────────┤
│ TSLA │ 100.0 %
└──────┴─────────┘

Annual (by 252) expected return: 124.85%
Annual (by √252) volatility: 68.44%
Sharpe ratio: 1.8215