BacktestNodePacket
BacktestNodePacket()
BacktestNodePacket(
user_id: int,
project_id: int,
session_id: str,
algorithm_data: List[int],
starting_capital: float,
name: str,
)
BacktestNodePacket(
user_id: int,
project_id: int,
session_id: str,
algorithm_data: List[int],
name: str,
starting_capital: Optional[CashAmount] = None,
)
Bases: AlgorithmNodePacket
Algorithm backtest task information packet.
Signature descriptions:
-
Default constructor for JSON
-
Initialize the backtest task packet.
name: str
Name of the backtest as randomly defined in the IDE.
backtest_id: str
BacktestId / Algorithm Id for this task
optimization_id: str
Optimization Id for this task
period_start: Optional[datetime]
Backtest start-date as defined in the Initialize() method.
period_finish: Optional[datetime]
Backtest end date as defined in the Initialize() method.
out_of_sample_max_end_date: Optional[datetime]
Backtest maximum end date
out_of_sample_days: int
The backtest out of sample day count
tradeable_dates: int
Estimated number of trading days in this backtest task based on the start-end dates.
debugging: bool
True, if this is a debugging backtest
channel: str
User unique specific channel endpoint to send the packets
python_virtual_environment: str
Virtual environment ID used to find PythonEvironments Ideally MD5, but environment names work as well.
host_name: str
The host name to use if any
user_id: int
User Id placing request
user_token: str
organization_id: str
project_id: int
Project Id of the request
project_name: str
Project name of the request
algorithm_id: str
Algorithm Id - BacktestId or DeployId - Common Id property between packets.
session_id: str
User session Id for authentication
compile_id: str
Unique compile id of this backtest
version: str
Version number identifier for the lean engine.
redelivered: bool
An algorithm packet which has already been run and is being redelivered on this node. In this event we don't want to relaunch the task as it may result in unexpected behaviour for user.
algorithm: List[int]
Algorithm binary with zip of contents
request_source: str
Request source - Web IDE or API - for controling result handler behaviour
ram_allocation: int
The maximum amount of RAM (in MB) this algorithm is allowed to utilize
parameters: Dictionary[str, str]
The parameter values used to set algorithm parameters
history_provider: str
String name of the HistoryProvider we're running with
get_algorithm_name() -> str
Gets a unique name for the algorithm defined by this packet