Files
quantconnect--lean/Common/Api/Optimization.cs
T
Andreas Sundebo e2de241c2b
Build & Test Lean / build (push) Has been cancelled
Regression Tests / build (push) Has been cancelled
Feature 5090 add api optimization methods (#6108)
* Move Optimizer-related DTOs and JSON converters into Common/Optimizer

* Add REST methods for Optimization

* Move OptimizationStatus into Common

* Change optimizationId parameter type to string

* Update Optimization and add lightweight optimization object

* Rename lightweight optimization to BaseOptimization and remove unneccessary properties

* Remove snapshotId from Optimization, add ParameterSet to Backtest

* Add missing IApi.cs method signatures

* Move ParameterSet into Common

* Replace Backtest with OptimizationBacktest

* Update UpdateOptimization to not include null or empty name and layout params in the request

* Change Objective targetTemplate regex pattern from ['(.+)'] to (.+) to prevent escaping target strings without whitespace

* Return Estimate object when calling EstimateOptimization

* Use DefaultNamingStrategy when serializing constraint operators

* Revert "Change Objective targetTemplate regex pattern from ['(.+)'] to (.+) to prevent escaping target strings without whitespace"

This reverts commit fbe7de0fd77dccc62e8c52c42a4ec9c18347acb2.

* Update Api method signatures

* Add unit tests

* Fix XML comment referring to the old class name

* Fix XML summary for OptimizationResponseWrapper

* Address review feedback
- Remove unused testOrganizationId
- Change NodeType from string to NodeType enum
- Clarify unit types for Estimate time and balance
- Simplify JsonConverter classes

* Add accessors to Common/Api classes

* Define performance metrics names in PerformanceMetrics class

* Remove unnecessary branching logic from GetSeriesValues method

* Add crefs and examples to XML comments in the Api class

* Revert "Change NodeType from string to NodeType enum"

* Remove layout param from UpdateOptimization method

* Backtest property ParameterSet should be of type ParameterSet

* Add asserts for deserialization in OptimizationBacktestJsonConverterTests

* Replace the three target-related properties with Criterion

* Add serialization and deserialization tests for Optimization

* Remove Optimization Serialization test

* Add EstimateDeserialization test

* Add asserts for integration tests

* Address self review

* Revert test case

* Update Nodes.cs

* Update Nodes.cs

* Set Aborted status when Optimization fails to start

* Add ParameterSetJsonConverter and ParameterSetJsonConverterTests

Co-authored-by: Martin-Molinero <martin@quantconnect.com>
2021-12-22 13:14:56 -03:00

96 lines
3.4 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;
using System.Collections.Generic;
using Newtonsoft.Json;
using QuantConnect.Optimizer.Objectives;
using QuantConnect.Optimizer.Parameters;
namespace QuantConnect.Api
{
/// <summary>
/// Optimization response packet from the QuantConnect.com API.
/// </summary>
public class Optimization : BaseOptimization
{
/// <summary>
/// Runtime banner/updating statistics for the optimization
/// </summary>
[JsonProperty(PropertyName = "runtimeStatistics", NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, string> RuntimeStatistics { get; set; }
/// <summary>
/// Optimization constraints
/// </summary>
[JsonProperty(PropertyName = "constraints", NullValueHandling = NullValueHandling.Ignore)]
public IReadOnlyList<Constraint> Constraints { get; set; }
/// <summary>
/// Optimization parameters
/// </summary>
[JsonProperty(PropertyName = "parameters", NullValueHandling = NullValueHandling.Ignore)]
public HashSet<OptimizationParameter> Parameters { get; set; }
/// <summary>
/// Number of parallel nodes for optimization
/// </summary>
[JsonProperty(PropertyName = "parallelNodes")]
public int ParallelNodes { get; set; }
/// <summary>
/// Optimization constraints
/// </summary>
[JsonProperty(PropertyName = "backtests", NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, OptimizationBacktest> Backtests { get; set; }
/// <summary>
/// Optimization strategy
/// </summary>
[JsonProperty(PropertyName = "strategy")]
public string Strategy { get; set; }
/// <summary>
/// Optimization requested date and time
/// </summary>
[JsonProperty(PropertyName = "requested")]
public DateTime Requested { get; set; }
}
/// <summary>
/// Wrapper class for Optimizations/Read endpoint JSON response
/// </summary>
public class OptimizationResponseWrapper : RestResponse
{
/// <summary>
/// Optimization object
/// </summary>
[JsonProperty(PropertyName = "optimization")]
public Optimization Optimization { get; set; }
}
/// <summary>
/// Collection container for a list of summarized optimizations for a project
/// </summary>
public class OptimizationList : RestResponse
{
/// <summary>
/// Collection of summarized optimization objects
/// </summary>
[JsonProperty(PropertyName = "optimizations")]
public List<BaseOptimization> Optimizations { get; set; }
}
}