AlgorithmNodePacket
AlgorithmNodePacket(type: PacketType)
Bases: PythonEnvironmentPacket
Algorithm Node Packet is a work task for the Lean Engine
Default constructor for the algorithm node:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type
|
PacketType
|
|
required |
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
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.
get_algorithm_name() -> str
Gets a unique name for the algorithm defined by this packet