Lean  $LEAN_TAG$
QuantConnect.Optimizer.Strategies.IOptimizationStrategy Interface Reference

Defines the optimization settings, direction, solution and exit, i.e. optimization strategy More...

Inheritance diagram for QuantConnect.Optimizer.Strategies.IOptimizationStrategy:
[legend]

Public Member Functions

void Initialize (Target target, IReadOnlyList< Constraint > constraints, HashSet< OptimizationParameter > parameters, OptimizationStrategySettings settings)
 Initializes the strategy using generator, extremum settings and optimization parameters More...
 
void PushNewResults (OptimizationResult result)
 Callback when lean compute job completed. More...
 
int GetTotalBacktestEstimate ()
 Estimates amount of parameter sets that can be run More...
 

Properties

OptimizationResult Solution [get]
 Best found solution, its value and parameter set More...
 

Events

EventHandler< ParameterSetNewParameterSet
 Fires when new parameter set is retrieved More...
 

Detailed Description

Defines the optimization settings, direction, solution and exit, i.e. optimization strategy

Definition at line 26 of file IOptimizationStrategy.cs.

Member Function Documentation

◆ Initialize()

void QuantConnect.Optimizer.Strategies.IOptimizationStrategy.Initialize ( Target  target,
IReadOnlyList< Constraint constraints,
HashSet< OptimizationParameter parameters,
OptimizationStrategySettings  settings 
)

Initializes the strategy using generator, extremum settings and optimization parameters

Parameters
targetThe optimization target
constraintsThe optimization constraints to apply on backtest results
parametersoptimization parameters
settingsoptimization strategy advanced settings

Implemented in QuantConnect.Optimizer.Strategies.StepBaseOptimizationStrategy, and QuantConnect.Optimizer.Strategies.EulerSearchOptimizationStrategy.

Here is the caller graph for this function:

◆ PushNewResults()

void QuantConnect.Optimizer.Strategies.IOptimizationStrategy.PushNewResults ( OptimizationResult  result)

Callback when lean compute job completed.

Parameters
resultLean compute job result and corresponding parameter set

Implemented in QuantConnect.Optimizer.Strategies.StepBaseOptimizationStrategy, QuantConnect.Optimizer.Strategies.EulerSearchOptimizationStrategy, and QuantConnect.Optimizer.Strategies.GridSearchOptimizationStrategy.

Here is the caller graph for this function:

◆ GetTotalBacktestEstimate()

int QuantConnect.Optimizer.Strategies.IOptimizationStrategy.GetTotalBacktestEstimate ( )

Estimates amount of parameter sets that can be run

Implemented in QuantConnect.Optimizer.Strategies.StepBaseOptimizationStrategy.

Here is the caller graph for this function:

Property Documentation

◆ Solution

OptimizationResult QuantConnect.Optimizer.Strategies.IOptimizationStrategy.Solution
get

Best found solution, its value and parameter set

Definition at line 36 of file IOptimizationStrategy.cs.

Event Documentation

◆ NewParameterSet

EventHandler<ParameterSet> QuantConnect.Optimizer.Strategies.IOptimizationStrategy.NewParameterSet

Fires when new parameter set is retrieved

Definition at line 31 of file IOptimizationStrategy.cs.


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