Files
quantconnect--lean/Algorithm.CSharp/MaximumSectorExposureRiskManagementModelFrameworkRegressionAlgorithm.cs
T
JosueNina 7008d17714
API Tests / build (push) Has been cancelled
Benchmarks / build (push) Has been cancelled
Build & Test Lean / build (push) Has been cancelled
Regression Tests / build (push) Has been cancelled
Report Generator Tests / build (push) Has been cancelled
Research Regression Tests / build (push) Has been cancelled
Syntax Tests / build (push) Has been cancelled
Python Virtual Environments / build (push) Has been cancelled
Add MaxDrawdownRecovery metric (#8865)
* Implement  a prototype of the maximum recovery time function.

* Add unit test skeletons.

* Add failing test

* Issue #4581: Implement MaxDrawdownRecoveryTime.

* Issue 4581: Add DTO for Drawdown Percentage, Drawdown Enddate, and High Value

* Issue 4581: Fix bgu for when lDrawdowns list is empty.

* Issue 4581: Change names of tests. Change name of file.

* Issue 4581: Make adjustements to flow of adding drawdowns to lDrawdowns.

* Issue 4581: Add multiple unit tests.

* Issue #4581: Change name of unit test

* Issue #4581: Add to PerformanceMetrics

* Issue #4581: Add Maximum Drawdown Recovery to PortolioStatistics class.

* Issue #4581: Add to portolfio statistics class.

* Issue #4581: Add to statistics builder.

* Issue #4581: Add report key.

* Case #4581: Convert to decimal.

* Issue #4581: Correct comment.

* Issue #4581: Correct performance metrics view model string.

* Case #4581: Correct statistics builder view model string..again.

* Issue #4581: Placed DradownDradownDateHighValueDTO at the end of the file for simpler diff.

* Issue #4581: Add 2 new tests.

* Issue #4581: Change algorithm so that when multiple maximum drawdowns occur, the longest of all recoveries is reported.

* Issue #4581: Add unit test.

* Issue #4581: Remove reportkey. Change dto name.

* Issue #4581: Change summary.

* Issue #4581: Change comment.

* Add max drawdown recovery calculation with unit tests

* Update regression algorithms with the new metric

* Solve review comments

* Update regression algorithms

* Add TryGet to safely get the key: MaximumDrawdownRecovery

* Ignore MaximumDrawdownRecovery metric in OptimizationBacktest Json

* Revert changes in Messaging

* Update regression algorithms

* Add test case: TakesLongestRecoveryAmongMultipleDrawdowns

* Use integer days for MaximumDrawdownRecovery

* Add MaximumDrawdownRecoveryReportElement

* Use more explicit names

* Rename files and variables for consistency

* Update regression algorithms

---------

Co-authored-by: Alain Schaerer <aschaerer@pcatg.com>
2025-07-17 16:32:23 -03:00

96 lines
3.8 KiB
C#

/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System.Collections.Generic;
using System.Linq;
using QuantConnect.Algorithm.Framework.Risk;
using QuantConnect.Algorithm.Framework.Selection;
namespace QuantConnect.Algorithm.CSharp
{
/// <summary>
/// Show example of how to use the <see cref="MaximumSectorExposureRiskManagementModel"/> Risk Management Model
/// </summary>
public class MaximumSectorExposureRiskManagementModelFrameworkRegressionAlgorithm : BaseFrameworkRegressionAlgorithm
{
public override void Initialize()
{
base.Initialize();
// Set requested data resolution
UniverseSettings.Resolution = Resolution.Daily;
SetStartDate(2014, 2, 1); //Set Start Date
SetEndDate(2014, 5, 1); //Set End Date
// set algorithm framework models
var tickers = new string[] { "AAPL", "MSFT", "GOOG", "AIG", "BAC" };
SetUniverseSelection(new FineFundamentalUniverseSelectionModel(
coarse => coarse.Where(x => tickers.Contains(x.Symbol.Value)).Select(x => x.Symbol),
fine => fine.Select(x => x.Symbol)
));
// define risk management model such that maximum weight of a single sector be 10%
// Number of of trades changed from 34 to 30 when using the MaximumSectorExposureRiskManagementModel
SetRiskManagement(new MaximumSectorExposureRiskManagementModel(0.1m));
}
public override void OnEndOfAlgorithm()
{
// The MaximumSectorExposureRiskManagementModel does not expire insights
}
/// <summary>
/// Data Points count of all timeslices of algorithm
/// </summary>
public override long DataPoints => 555;
/// <summary>
/// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
/// </summary>
public override Dictionary<string, string> ExpectedStatistics => new()
{
{"Total Orders", "15"},
{"Average Win", "0.09%"},
{"Average Loss", "-0.16%"},
{"Compounding Annual Return", "-2.427%"},
{"Drawdown", "1.400%"},
{"Expectancy", "-0.544"},
{"Start Equity", "100000"},
{"End Equity", "99396.26"},
{"Net Profit", "-0.604%"},
{"Sharpe Ratio", "-1.264"},
{"Sortino Ratio", "-0.962"},
{"Probabilistic Sharpe Ratio", "11.917%"},
{"Loss Rate", "71%"},
{"Win Rate", "29%"},
{"Profit-Loss Ratio", "0.60"},
{"Alpha", "-0.038"},
{"Beta", "0.078"},
{"Annual Standard Deviation", "0.019"},
{"Annual Variance", "0"},
{"Information Ratio", "-2.24"},
{"Tracking Error", "0.092"},
{"Treynor Ratio", "-0.312"},
{"Total Fees", "$18.92"},
{"Estimated Strategy Capacity", "$96000000.00"},
{"Lowest Capacity Asset", "AIG R735QTJ8XC9X"},
{"Portfolio Turnover", "0.80%"},
{"Drawdown Recovery", "0"},
{"OrderListHash", "34eff097cfac686aedf205bc2eaab4d4"}
};
}
}