Lean  $LEAN_TAG$
QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel Class Reference

Risk Parity Portfolio Construction Model More...

Inheritance diagram for QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel:
[legend]

Public Member Functions

 RiskParityPortfolioConstructionModel (IDateRule rebalancingDateRules, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
 RiskParityPortfolioConstructionModel (Resolution rebalanceResolution=Resolution.Daily, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
 RiskParityPortfolioConstructionModel (TimeSpan timeSpan, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
 RiskParityPortfolioConstructionModel (PyObject rebalance, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
 RiskParityPortfolioConstructionModel (Func< DateTime, DateTime > rebalancingFunc, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
 RiskParityPortfolioConstructionModel (Func< DateTime, DateTime?> rebalancingFunc, PortfolioBias portfolioBias=PortfolioBias.LongShort, int lookback=1, int period=252, Resolution resolution=Resolution.Daily, IPortfolioOptimizer optimizer=null)
 Initialize the model More...
 
override void OnSecuritiesChanged (QCAlgorithm algorithm, SecurityChanges changes)
 Event fired each time the we add/remove securities from the data feed More...
 
- Public Member Functions inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel
 PortfolioConstructionModel (Func< DateTime, DateTime?> rebalancingFunc)
 Initialize a new instance of PortfolioConstructionModel More...
 
 PortfolioConstructionModel (Func< DateTime, DateTime > rebalancingFunc=null)
 Initialize a new instance of PortfolioConstructionModel More...
 
virtual IEnumerable< IPortfolioTargetCreateTargets (QCAlgorithm algorithm, Insight[] insights)
 Create portfolio targets from the specified insights More...
 

Protected Member Functions

override Dictionary< Insight, double > DetermineTargetPercent (List< Insight > activeInsights)
 Will determine the target percent for each insight More...
 
- Protected Member Functions inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel
void SetPythonWrapper (PortfolioConstructionModelPythonWrapper pythonWrapper)
 Used to set the PortfolioConstructionModelPythonWrapper instance if any More...
 
virtual List< InsightGetTargetInsights ()
 Gets the target insights to calculate a portfolio target percent for More...
 
virtual bool ShouldCreateTargetForInsight (Insight insight)
 Method that will determine if the portfolio construction model should create a target for this insight More...
 
void SetRebalancingFunc (PyObject rebalance)
 Python helper method to set the rebalancing function. This is required due to a python net limitation not being able to use the base type constructor, and also because when python algorithms use C# portfolio construction models, it can't convert python methods into func nor resolve the correct constructor for the date rules, timespan parameter. For performance we prefer python algorithms using the C# implementation More...
 
virtual bool IsRebalanceDue (Insight[] insights, DateTime algorithmUtc)
 Determines if the portfolio should be rebalanced base on the provided rebalancing func, if any security change have been taken place or if an insight has expired or a new insight arrived If the rebalancing function has not been provided will return true. More...
 
void RefreshRebalance (DateTime algorithmUtc)
 Refresh the next rebalance time and clears the security changes flag More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel
static Insight[] FilterInvalidInsightMagnitude (IAlgorithm algorithm, Insight[] insights)
 Helper class that can be used by the different IPortfolioConstructionModel implementations to filter Insight instances with an invalid Insight.Magnitude value based on the IAlgorithmSettings More...
 
- Protected Attributes inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel
PortfolioConstructionModelPythonWrapper PythonWrapper
 This is required due to a limitation in PythonNet to resolved overriden methods. When Python calls a C# method that calls a method that's overriden in python it won't run the python implementation unless the call is performed through python too. More...
 
- Properties inherited from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel
virtual bool RebalanceOnSecurityChanges = true [get, set]
 True if should rebalance portfolio on security changes. True by default More...
 
virtual bool RebalanceOnInsightChanges = true [get, set]
 True if should rebalance portfolio on new insights or expiration of insights. True by default More...
 
IAlgorithm Algorithm [get]
 The algorithm instance More...
 

Detailed Description

Risk Parity Portfolio Construction Model

Spinu, F. (2013). An algorithm for computing risk parity weights. Available at SSRN 2297383. Available at https://papers.ssrn.com/sol3/Papers.cfm?abstract_id=2297383

Definition at line 34 of file RiskParityPortfolioConstructionModel.cs.

Constructor & Destructor Documentation

◆ RiskParityPortfolioConstructionModel() [1/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( IDateRule  rebalancingDateRules,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
rebalancingDateRulesThe date rules used to define the next expected rebalance time in UTC
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

Definition at line 51 of file RiskParityPortfolioConstructionModel.cs.

◆ RiskParityPortfolioConstructionModel() [2/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( Resolution  rebalanceResolution = Resolution.Daily,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
rebalanceResolutionRebalancing frequency
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

Definition at line 70 of file RiskParityPortfolioConstructionModel.cs.

◆ RiskParityPortfolioConstructionModel() [3/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( TimeSpan  timeSpan,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
timeSpanRebalancing frequency
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

Definition at line 89 of file RiskParityPortfolioConstructionModel.cs.

◆ RiskParityPortfolioConstructionModel() [4/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( PyObject  rebalance,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
rebalanceRebalancing func or if a date rule, timedelta will be converted into func. For a given algorithm UTC DateTime the func returns the next expected rebalance time or null if unknown, in which case the function will be called again in the next loop. Returning current time will trigger rebalance. If null will be ignored
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

This is required since python net can not convert python methods into func nor resolve the correct constructor for the date rules parameter. For performance we prefer python algorithms using the C# implementation

Definition at line 114 of file RiskParityPortfolioConstructionModel.cs.

Here is the call graph for this function:

◆ RiskParityPortfolioConstructionModel() [5/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( Func< DateTime, DateTime >  rebalancingFunc,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
rebalancingFuncFor a given algorithm UTC DateTime returns the next expected rebalance UTC time. Returning current time will trigger rebalance. If null will be ignored
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

Definition at line 135 of file RiskParityPortfolioConstructionModel.cs.

◆ RiskParityPortfolioConstructionModel() [6/6]

QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.RiskParityPortfolioConstructionModel ( Func< DateTime, DateTime?>  rebalancingFunc,
PortfolioBias  portfolioBias = PortfolioBias.LongShort,
int  lookback = 1,
int  period = 252,
Resolution  resolution = Resolution.Daily,
IPortfolioOptimizer  optimizer = null 
)

Initialize the model

Parameters
rebalancingFuncFor a given algorithm UTC DateTime returns the next expected rebalance time or null if unknown, in which case the function will be called again in the next loop. Returning current time will trigger rebalance.
portfolioBiasSpecifies the bias of the portfolio (Short, Long/Short, Long)
lookbackHistorical return lookback period
periodThe time interval of history price to calculate the weight
resolutionThe resolution of the history price
optimizerThe portfolio optimization algorithm. If the algorithm is not provided then the default will be mean-variance optimization.

Definition at line 161 of file RiskParityPortfolioConstructionModel.cs.

Member Function Documentation

◆ DetermineTargetPercent()

override Dictionary<Insight, double> QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.DetermineTargetPercent ( List< Insight activeInsights)
protectedvirtual

Will determine the target percent for each insight

Parameters
activeInsightsThe active insights to generate a target for
Returns
A target percent for each insight

Reimplemented from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel.

Definition at line 188 of file RiskParityPortfolioConstructionModel.cs.

◆ OnSecuritiesChanged()

override void QuantConnect.Algorithm.Framework.Portfolio.RiskParityPortfolioConstructionModel.OnSecuritiesChanged ( QCAlgorithm  algorithm,
SecurityChanges  changes 
)
virtual

Event fired each time the we add/remove securities from the data feed

Parameters
algorithmThe algorithm instance that experienced the change in securities
changesThe security additions and removals from the algorithm

Reimplemented from QuantConnect.Algorithm.Framework.Portfolio.PortfolioConstructionModel.

Definition at line 227 of file RiskParityPortfolioConstructionModel.cs.


The documentation for this class was generated from the following file: