Skip to content

Commit 6e68f0f

Browse files
committed
Fix docs description
1 parent afa5ab1 commit 6e68f0f

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

investing_algorithm_framework/app/strategy.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ class TradingStrategy:
1616
strategy is a set of rules that defines when to buy or sell an asset.
1717
1818
Attributes:
19-
id (string): the unique id for your combined strategy instances
19+
algorithm_id (string): the unique id for your
20+
combined strategy instances. An algorithm consists out of one or
21+
more strategy instances that run together. The algorithm_id
22+
is used to uniquely indentify the combined strategy instances.
23+
This is id is used in various places in the framework, e.g. for
24+
backtesting results, logging, monitoring etc.
2025
time_unit (TimeUnit): the time unit of the strategy that defines
2126
when the strategy should run e.g. HOUR, DAY, WEEK, MONTH
2227
interval (int): the interval of the strategy that defines how often
@@ -34,7 +39,7 @@ class TradingStrategy:
3439
store additional information about the strategy, such as its
3540
author, version, description, params etc.
3641
"""
37-
id: str
42+
algorithm_id: str
3843
time_unit: TimeUnit = None
3944
interval: int = None
4045
worker_id: str = None

0 commit comments

Comments
 (0)