Lean  $LEAN_TAG$
QuantConnect.Optimizer.OptimizationNodePacket Class Reference

Provide a packet type containing information on the optimization compute job. More...

Inheritance diagram for QuantConnect.Optimizer.OptimizationNodePacket:
[legend]

Public Member Functions

 OptimizationNodePacket ()
 Creates a new instance More...
 
- Public Member Functions inherited from QuantConnect.Packets.Packet
 Packet (PacketType type)
 Initialize the base class and setup the packet type. More...
 

Protected Member Functions

 OptimizationNodePacket (PacketType packetType)
 Creates a new instance More...
 

Properties

string Name [get, set]
 The optimization name More...
 
DateTime Created [get, set]
 The creation time More...
 
int UserId [get, set]
 User Id placing request More...
 
string UserToken = string.Empty [get, set]
 User API Token.
 
int ProjectId [get, set]
 Project Id of the request More...
 
string CompileId = string.Empty [get, set]
 Unique compile id of this optimization More...
 
string OptimizationId = string.Empty [get, set]
 The unique optimization Id of the request More...
 
string OrganizationId = string.Empty [get, set]
 Organization Id of the request More...
 
int MaximumConcurrentBacktests [get, set]
 Limit for the amount of concurrent backtests being run More...
 
string OptimizationStrategy = "QuantConnect.Optimizer.Strategies.GridSearchOptimizationStrategy" [get, set]
 Optimization strategy name More...
 
Target Criterion [get, set]
 Objective settings More...
 
IReadOnlyList< ConstraintConstraints [get, set]
 Optimization constraints More...
 
HashSet< OptimizationParameterOptimizationParameters [get, set]
 The user optimization parameters More...
 
OptimizationStrategySettings OptimizationStrategySettings [get, set]
 The user optimization parameters More...
 
DateTime? OutOfSampleMaxEndDate [get, set]
 Backtest out of sample maximum end date More...
 
int OutOfSampleDays [get, set]
 The backtest out of sample day count More...
 
- Properties inherited from QuantConnect.Packets.Packet
PacketType Type = PacketType.None [get, set]
 Packet type defined by a string enum More...
 
virtual string Channel = "" [get, set]
 User unique specific channel endpoint to send the packets More...
 

Detailed Description

Provide a packet type containing information on the optimization compute job.

Definition at line 30 of file OptimizationNodePacket.cs.

Constructor & Destructor Documentation

◆ OptimizationNodePacket() [1/2]

QuantConnect.Optimizer.OptimizationNodePacket.OptimizationNodePacket ( )

Creates a new instance

Definition at line 115 of file OptimizationNodePacket.cs.

◆ OptimizationNodePacket() [2/2]

QuantConnect.Optimizer.OptimizationNodePacket.OptimizationNodePacket ( PacketType  packetType)
protected

Creates a new instance

Definition at line 122 of file OptimizationNodePacket.cs.

Property Documentation

◆ Name

string QuantConnect.Optimizer.OptimizationNodePacket.Name
getset

The optimization name

Definition at line 35 of file OptimizationNodePacket.cs.

◆ Created

DateTime QuantConnect.Optimizer.OptimizationNodePacket.Created
getset

The creation time

Definition at line 41 of file OptimizationNodePacket.cs.

◆ UserId

int QuantConnect.Optimizer.OptimizationNodePacket.UserId
getset

User Id placing request

Definition at line 46 of file OptimizationNodePacket.cs.

◆ ProjectId

int QuantConnect.Optimizer.OptimizationNodePacket.ProjectId
getset

Project Id of the request

Definition at line 54 of file OptimizationNodePacket.cs.

◆ CompileId

string QuantConnect.Optimizer.OptimizationNodePacket.CompileId = string.Empty
getset

Unique compile id of this optimization

Definition at line 59 of file OptimizationNodePacket.cs.

◆ OptimizationId

string QuantConnect.Optimizer.OptimizationNodePacket.OptimizationId = string.Empty
getset

The unique optimization Id of the request

Definition at line 64 of file OptimizationNodePacket.cs.

◆ OrganizationId

string QuantConnect.Optimizer.OptimizationNodePacket.OrganizationId = string.Empty
getset

Organization Id of the request

Definition at line 69 of file OptimizationNodePacket.cs.

◆ MaximumConcurrentBacktests

int QuantConnect.Optimizer.OptimizationNodePacket.MaximumConcurrentBacktests
getset

Limit for the amount of concurrent backtests being run

Definition at line 74 of file OptimizationNodePacket.cs.

◆ OptimizationStrategy

string QuantConnect.Optimizer.OptimizationNodePacket.OptimizationStrategy = "QuantConnect.Optimizer.Strategies.GridSearchOptimizationStrategy"
getset

Optimization strategy name

Definition at line 79 of file OptimizationNodePacket.cs.

◆ Criterion

Target QuantConnect.Optimizer.OptimizationNodePacket.Criterion
getset

Objective settings

Definition at line 84 of file OptimizationNodePacket.cs.

◆ Constraints

IReadOnlyList<Constraint> QuantConnect.Optimizer.OptimizationNodePacket.Constraints
getset

Optimization constraints

Definition at line 89 of file OptimizationNodePacket.cs.

◆ OptimizationParameters

HashSet<OptimizationParameter> QuantConnect.Optimizer.OptimizationNodePacket.OptimizationParameters
getset

The user optimization parameters

Definition at line 94 of file OptimizationNodePacket.cs.

◆ OptimizationStrategySettings

OptimizationStrategySettings QuantConnect.Optimizer.OptimizationNodePacket.OptimizationStrategySettings
getset

The user optimization parameters

Definition at line 100 of file OptimizationNodePacket.cs.

◆ OutOfSampleMaxEndDate

DateTime? QuantConnect.Optimizer.OptimizationNodePacket.OutOfSampleMaxEndDate
getset

Backtest out of sample maximum end date

Definition at line 105 of file OptimizationNodePacket.cs.

◆ OutOfSampleDays

int QuantConnect.Optimizer.OptimizationNodePacket.OutOfSampleDays
getset

The backtest out of sample day count

Definition at line 110 of file OptimizationNodePacket.cs.


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