From 999ecb7dca1352b2914d0e4c05fe9e3c12e9cfc1 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 8 Jan 2021 14:22:16 +0100 Subject: [PATCH] Network Trading Bot Instance --- .../Docs-Concepts/reusable-snippets.json | 13 ++ .../snippet-for-hierarchy-tables.json | 18 --- .../Docs-Nodes/forward-testing-session.json | 6 +- .../Docs-Nodes/live-trading-session.json | 6 +- .../Docs-Nodes/production-trading-tasks.json | 12 +- .../Docs-Nodes/project-trading-tasks.json | 8 +- .../Docs-Nodes/testing-trading-tasks.json | 8 +- .../Docs-Nodes/trading-bot-instance.json | 4 +- .../network-003-data-tasks-section.json | 86 +---------- ...04-indicator-and-sensor-bot-instances.json | 106 +++++++++++++ ...ork-005-testing-trading-tasks-section.json | 124 +++++++++++++++ ...-006-production-trading-tasks-section.json | 30 ++++ ...ing-bot-instance-and-trading-sessions.json | 144 ++++++++++++++++++ 13 files changed, 447 insertions(+), 118 deletions(-) delete mode 100644 Projects/Superalgos/Schemas/Docs-Concepts/snippet-for-hierarchy-tables.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/network-004-indicator-and-sensor-bot-instances.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/network-005-testing-trading-tasks-section.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/network-006-production-trading-tasks-section.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/network-007-trading-bot-instance-and-trading-sessions.json diff --git a/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json b/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json index 067230bc3..f5cbe019c 100644 --- a/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json +++ b/Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json @@ -16,6 +16,19 @@ { "style": "Note", "text": "This page discusses the top-level information about the section of the hierarchy represented on the below table. Click on any of the nodes to get the details." + }, + { + "style": "Title", + "text": "Important for Live Sessions" + }, + { + "style": "Block", + "text": "Important for Live Sessions" + }, + { + "style": "Important", + "text": "Running a live session requires the setup of a key reference at the Task. It also requires a live data feed, meaning that the corresponding Sensor Bot Instance, along with all indicators used by the referenced Trading System, must be up and running. Finally, a live session also requires at least 48 hours of historic market data. Bear in mind that the Trading System may require even more historic market data to properly analyze the market depending on the indicators used.", + "updated": 1610106222219 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Concepts/snippet-for-hierarchy-tables.json b/Projects/Superalgos/Schemas/Docs-Concepts/snippet-for-hierarchy-tables.json deleted file mode 100644 index 0c62edf09..000000000 --- a/Projects/Superalgos/Schemas/Docs-Concepts/snippet-for-hierarchy-tables.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "type": "Snippet for Hierarchy Tables", - "definition": { - "text": "Use the snippet below to preceed hierarchy tables on topics discussing hierarchies.\n", - "updated": 1610044206329 - }, - "paragraphs": [ - { - "style": "Block", - "text": "Snippet", - "updated": 1610049026050 - }, - { - "style": "Note", - "text": "This page discusses the top-level information about the section of the hierarchy represented on the below table. Click on any of the nodes to get the details." - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/forward-testing-session.json b/Projects/Superalgos/Schemas/Docs-Nodes/forward-testing-session.json index bde3624c5..13c7f7f64 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/forward-testing-session.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/forward-testing-session.json @@ -13,9 +13,9 @@ "text": "A forward testing session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it." }, { - "style": "Important", - "text": "Running a live session requires the setup of a key reference at the Task. It also requires a live data feed, meaning that the corresponding sensor bot, along with all indicators used by the referenced trading system, must be up and running. Finally, a live session also requires at least 48 hours of historic market data. Bear in mind that the trading system may require even more historic market data to properly analyze the market.", - "updated": 1609673944485 + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Important for Live Sessions", + "updated": 1610106317263 }, { "style": "Block", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/live-trading-session.json b/Projects/Superalgos/Schemas/Docs-Nodes/live-trading-session.json index 24fc0c6f1..4bf4b4fb1 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/live-trading-session.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/live-trading-session.json @@ -13,9 +13,9 @@ "text": "A live trading session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it." }, { - "style": "Important", - "text": "Running a live session requires the setup of a key reference at the Task. It also requires a live data feed, meaning that the corresponding sensor bot, along with all indicators used by the referenced trading system, must be up and running. Finally, a live session also requires at least 48 hours of historic market data. Bear in mind that the trading system may require even more historic market data to properly analyze the market.", - "updated": 1609673958673 + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Important for Live Sessions", + "updated": 1610106381144 }, { "style": "Block", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/production-trading-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/production-trading-tasks.json index 7d23bf44b..3caa0ce24 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/production-trading-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/production-trading-tasks.json @@ -1,10 +1,14 @@ { "type": "Production Trading Tasks", "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1610106726574 + }, { "style": "Text", - "text": "Superalgos aims to provide a flexible and robust trading bots deployment toolbox.", - "updated": 1609666709477 + "text": "Superalgos aims to provide a flexible and robust trading bots deployment toolbox." }, { "style": "Text", @@ -25,8 +29,8 @@ }, { "style": "Note", - "text": "If you are familiar with the testing environment, there isn’t much more to learn to understand the production environment. If you are not familiar with either, please refer to the tesing environment page for the details.", - "updated": 1609666722398 + "text": "If you are familiar with Testing Trading Tasks, there isn’t much more to learn to understand Production Trading Tasks. If you are not familiar with either, please refer to the Testing Trading Tasks Section page for the details.", + "updated": 1610111338574 }, { "style": "Important", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/project-trading-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/project-trading-tasks.json index 2e83b8f37..577fd79ac 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/project-trading-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/project-trading-tasks.json @@ -1,10 +1,14 @@ { "type": "Project Trading Tasks", "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1610099516571 + }, { "style": "Note", - "text": "Superalgos organizes the data structures in the Network by Project to ensure scalability.", - "updated": 1609667622393 + "text": "Superalgos organizes the data structures in the Network by Project to ensure scalability." } ], "definition": { diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/testing-trading-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/testing-trading-tasks.json index c6e82499d..616c79984 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/testing-trading-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/testing-trading-tasks.json @@ -1,10 +1,14 @@ { "type": "Testing Trading Tasks", "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1610098901334 + }, { "style": "Text", - "text": "Thorough and comprehensive testing of strategies is at the core of successful trading. Superalgos strives to put you in control of the testing process providing you with flexible tools to fit your criteria.", - "updated": 1609666609067 + "text": "Thorough and comprehensive testing of strategies is at the core of successful trading. Superalgos strives to put you in control of the testing process providing you with flexible tools to fit your criteria." }, { "style": "Text", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/trading-bot-instance.json b/Projects/Superalgos/Schemas/Docs-Nodes/trading-bot-instance.json index 2400a1892..385b1e6cf 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/trading-bot-instance.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/trading-bot-instance.json @@ -11,8 +11,8 @@ }, { "style": "Text", - "text": "The rading bot instance holds no definitions as to what the bot does. Instead, its process instance references the process definition in the Masters data mine. That is how the indicator bot instance obtains the information of what it needs to do once it is run.", - "updated": 1609668704862 + "text": "The trading bot instance holds no definitions as to what the bot does. Instead, its process instance references the process definition in the Masters data mine. That is how the indicator bot instance obtains the information of what it needs to do once it is run.", + "updated": 1610105308091 }, { "style": "Note", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/network-003-data-tasks-section.json b/Projects/Superalgos/Schemas/Docs-Topics/network-003-data-tasks-section.json index 142f53c4e..cc20cd9db 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/network-003-data-tasks-section.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/network-003-data-tasks-section.json @@ -92,90 +92,8 @@ }, { "style": "Callout", - "text": "Data tasks may run instances of Indicator Bots or Sensor Bots, and some exchange may require an API key for downloading certain kinds or amounts of data. We will look into each of these cases.", - "updated": 1610053358825 - }, - { - "style": "Title", - "text": "Indicator Bot Instance" - }, - { - "style": "Hierarchy", - "text": "Superalgos->Indicator Bot Instance->5", - "updated": 1610052779634 - }, - { - "style": "Include", - "text": "Superalgos->Node->Indicator Bot Instance->Definition", - "updated": 1610052992001 - }, - { - "style": "Include", - "text": "Superalgos->Node->Indicator Bot Instance->Content", - "updated": 1610053001117 - }, - { - "style": "Subtitle", - "text": "Indicator Process Instance", - "updated": 1610053039264 - }, - { - "style": "Include", - "text": "Superalgos->Node->Indicator Process Instance->Definition", - "updated": 1610053043468 - }, - { - "style": "Include", - "text": "Superalgos->Node->Indicator Process Instance->Content", - "updated": 1610053048925 - }, - { - "style": "Subtitle", - "text": "Time Frames Filter", - "updated": 1610053086734 - }, - { - "style": "Include", - "text": "Superalgos->Node->Time Frames Filter->Definition", - "updated": 1610053096751 - }, - { - "style": "Include", - "text": "Superalgos->Node->Time Frames Filter->Content->", - "updated": 1610053112916 - }, - { - "style": "Title", - "text": "Sensor Bot Instance" - }, - { - "style": "Hierarchy", - "text": "Superalgos->Sensor Bot Instance->5" - }, - { - "style": "Include", - "text": "Superalgos->Node->Sensor Bot Instance->Definition", - "updated": 1610053220123 - }, - { - "style": "Include", - "text": "Superalgos->Node->Sensor Bot Instance->Content", - "updated": 1610053224701 - }, - { - "style": "Subtitle", - "text": "Sensor Process Instance", - "updated": 1610051983233 - }, - { - "style": "Include", - "text": "Superalgos->Node->Sensor Process Instance->Definition", - "updated": 1610053248186 - }, - { - "style": "Include", - "text": "Superalgos->Node->Sensor Process Instance->Content", - "updated": 1610053252094 + "text": "Data tasks may run instances of Indicator Bots or Sensor Bots. We'll cover those two in the next page. Some exchanges may require an API key for downloading certain kinds or amounts of data. Let's look into the Key Reference node.", + "updated": 1610104190961 }, { "style": "Title", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/network-004-indicator-and-sensor-bot-instances.json b/Projects/Superalgos/Schemas/Docs-Topics/network-004-indicator-and-sensor-bot-instances.json new file mode 100644 index 000000000..cc60b4948 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/network-004-indicator-and-sensor-bot-instances.json @@ -0,0 +1,106 @@ +{ + "topic": "Network", + "pageNumber": "4", + "type": "Indicator and Sensor Bot Instances", + "definition": { + "text": "Data tasks may run instances of Indicator Bots or Sensor Bots, and some exchange may require an API key for downloading certain kinds or amounts of data. We will look into each of these cases.", + "updated": 1610103659306 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Indicator Bot Instance" + }, + { + "style": "Include", + "text": "Superalgos->Node->Indicator Bot Instance->Definition", + "updated": 1610052992001 + }, + { + "style": "Include", + "text": "Superalgos->Node->Indicator Bot Instance->Content", + "updated": 1610053001117 + }, + { + "style": "Hierarchy", + "text": "Superalgos->Indicator Bot Instance->5", + "updated": 1610103706186 + }, + { + "style": "Title", + "text": "Indicator Process Instance" + }, + { + "style": "Include", + "text": "Superalgos->Node->Indicator Process Instance->Definition", + "updated": 1610053043468 + }, + { + "style": "Include", + "text": "Superalgos->Node->Indicator Process Instance->Content", + "updated": 1610053048925 + }, + { + "style": "Title", + "text": "Time Frames Filter", + "updated": 1610053086734 + }, + { + "style": "Include", + "text": "Superalgos->Node->Time Frames Filter->Definition", + "updated": 1610053096751 + }, + { + "style": "Include", + "text": "Superalgos->Node->Time Frames Filter->Content->", + "updated": 1610053112916 + }, + { + "style": "Title", + "text": "Sensor Bot Instance" + }, + { + "style": "Include", + "text": "Superalgos->Node->Sensor Bot Instance->Definition", + "updated": 1610053220123 + }, + { + "style": "Include", + "text": "Superalgos->Node->Sensor Bot Instance->Content", + "updated": 1610053224701 + }, + { + "style": "Hierarchy", + "text": "Superalgos->Sensor Bot Instance->2", + "updated": 1610103781696 + }, + { + "style": "Title", + "text": "Sensor Process Instance" + }, + { + "style": "Include", + "text": "Superalgos->Node->Sensor Process Instance->Definition", + "updated": 1610053248186 + }, + { + "style": "Include", + "text": "Superalgos->Node->Sensor Process Instance->Content", + "updated": 1610053252094 + }, + { + "style": "Title", + "text": "Key Reference", + "updated": 1610103821335 + }, + { + "style": "Include", + "text": "Superalgos->Node->Key Reference->Definition" + }, + { + "style": "Include", + "text": "Superalgos->Node->Key Reference->Content", + "updated": 1610053479747 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/network-005-testing-trading-tasks-section.json b/Projects/Superalgos/Schemas/Docs-Topics/network-005-testing-trading-tasks-section.json new file mode 100644 index 000000000..fb01610c6 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/network-005-testing-trading-tasks-section.json @@ -0,0 +1,124 @@ +{ + "topic": "Network", + "pageNumber": "5", + "type": "Testing Trading Tasks Section", + "definition": { + "text": "The testing environment organizes your strategy-testing resources, grouping tasks and associated backtesting and paper trading sessions", + "updated": 1610098745062 + }, + "paragraphs": [ + { + "style": "Include", + "text": "Superalgos->Node->Testing Trading Tasks->Definition", + "updated": 1610098836922 + }, + { + "style": "Include", + "text": "Superalgos->Node->Testing Trading Tasks->Content", + "updated": 1610098839938 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables", + "updated": 1610099117367 + }, + { + "style": "Hierarchy", + "text": "Superalgos->Testing Trading Tasks->7", + "updated": 1610099143777 + }, + { + "style": "Title", + "text": "Project Trading Tasks", + "updated": 1610099464447 + }, + { + "style": "Include", + "text": "Superalgos->Node->Project Trading Tasks->Definition", + "updated": 1610099472471 + }, + { + "style": "Include", + "text": "Superalgos->Node->Project Trading Tasks->Content", + "updated": 1610099475424 + }, + { + "style": "Title", + "text": "Exchange Trading Tasks" + }, + { + "style": "Include", + "text": "Superalgos->Node->Exchange Trading Tasks->Definition", + "updated": 1610099304052 + }, + { + "style": "Include", + "text": "Superalgos->Node->Exchange Trading Tasks->Content", + "updated": 1610099319135 + }, + { + "style": "Title", + "text": "Market Trading Tasks", + "updated": 1610099570869 + }, + { + "style": "Include", + "text": "Superalgos->Node->Market Trading Tasks->Definition", + "updated": 1610099575741 + }, + { + "style": "Include", + "text": "Superalgos->Node->Market Trading Tasks->Content", + "updated": 1610099578861 + }, + { + "style": "Title", + "text": "Trading Mine Tasks", + "updated": 1610099612379 + }, + { + "style": "Include", + "text": "Superalgos->Node->Trading Mine Tasks->Definition", + "updated": 1610099623224 + }, + { + "style": "Include", + "text": "Superalgos->Node->Trading Mine Tasks->Content", + "updated": 1610099626491 + }, + { + "style": "Title", + "text": "Task Manager", + "updated": 1610099672822 + }, + { + "style": "Include", + "text": "Superalgos->Node->Task Manager->Definition", + "updated": 1610099685252 + }, + { + "style": "Include", + "text": "Superalgos->Node->Task Manager->Content", + "updated": 1610099688254 + }, + { + "style": "Title", + "text": "Task", + "updated": 1610099791047 + }, + { + "style": "Include", + "text": "Superalgos->Node->Task->Definition" + }, + { + "style": "Include", + "text": "Superalgos->Node->Task->Content", + "updated": 1610099795844 + }, + { + "style": "Callout", + "text": "Trading tasks run instances of the Trading Bot, which may run four different types of trading sessions. We shall study those in the next few pages.", + "updated": 1610100281413 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/network-006-production-trading-tasks-section.json b/Projects/Superalgos/Schemas/Docs-Topics/network-006-production-trading-tasks-section.json new file mode 100644 index 000000000..88ea46bfd --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/network-006-production-trading-tasks-section.json @@ -0,0 +1,30 @@ +{ + "topic": "Network", + "pageNumber": "6", + "type": "Production Trading Tasks Section", + "definition": { + "text": "The production environment organizes your strategy-deployment resources, grouping tasks and associated forward testing and live trading sessions.", + "updated": 1610106563761 + }, + "paragraphs": [ + { + "style": "Include", + "text": "Superalgos->Node->Production Trading Tasks->Definition", + "updated": 1610106660823 + }, + { + "style": "Include", + "text": "Superalgos->Node->Production Trading Tasks->Content", + "updated": 1610106664031 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables", + "updated": 1610111896199 + }, + { + "style": "Hierarchy", + "text": "Superalgos->Production Trading Tasks->7" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/network-007-trading-bot-instance-and-trading-sessions.json b/Projects/Superalgos/Schemas/Docs-Topics/network-007-trading-bot-instance-and-trading-sessions.json new file mode 100644 index 000000000..8ca194fbc --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/network-007-trading-bot-instance-and-trading-sessions.json @@ -0,0 +1,144 @@ +{ + "topic": "Network", + "pageNumber": "7", + "type": "Trading Bot Instance and Trading Sessions", + "definition": { + "text": "The Trading Bot Instance may run four different types of trading tasks: Backtesting Session, Paper Trading Session, Forward Testing Session, and Live Trading Session.", + "updated": 1610104458924 + }, + "paragraphs": [ + { + "style": "Include", + "text": "Superalgos->Node->Trading Bot Instance->Definition", + "updated": 1610104349814 + }, + { + "style": "Include", + "text": "Superalgos->Node->Trading Bot Instance->Content", + "updated": 1610104353367 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables", + "updated": 1610104559141 + }, + { + "style": "Hierarchy", + "text": "Superalgos->Trading Bot Instance->3", + "updated": 1610105354911 + }, + { + "style": "Title", + "text": "Trading Process Instance", + "updated": 1610105388480 + }, + { + "style": "Include", + "text": "Superalgos->Node->Trading Process Instance->Definition", + "updated": 1610105392651 + }, + { + "style": "Include", + "text": "Superalgos->Node->Trading Process Instance->Content", + "updated": 1610105395638 + }, + { + "style": "Title", + "text": "Backtesting Session", + "updated": 1610105426304 + }, + { + "style": "Include", + "text": "Superalgos->Node->Backtesting Session->Definition", + "updated": 1610105431567 + }, + { + "style": "Include", + "text": "Superalgos->Node->Backtesting Session->Content", + "updated": 1610105435332 + }, + { + "style": "Title", + "text": "Paper Trading Session", + "updated": 1610105446863 + }, + { + "style": "Include", + "text": "Superalgos->Node->Paper Trading Session->Definition", + "updated": 1610105455085 + }, + { + "style": "Include", + "text": "Superalgos->Node->Paper Trading Session->Content", + "updated": 1610105458675 + }, + { + "style": "Title", + "text": "Forward Testing Session", + "updated": 1610105468103 + }, + { + "style": "Include", + "text": "Superalgos->Node->Forward Testing Session->Definition", + "updated": 1610105490548 + }, + { + "style": "Include", + "text": "Superalgos->Node->Forward Testing Session->Content", + "updated": 1610105494921 + }, + { + "style": "Title", + "text": "Live Trading Session", + "updated": 1610105511436 + }, + { + "style": "Include", + "text": "Superalgos->Node->Live Trading Session->Definition" + }, + { + "style": "Include", + "text": "Superalgos->Node->Live Trading Session->Content", + "updated": 1610105515022 + }, + { + "style": "Title", + "text": "Execution Started Event", + "updated": 1610105590828 + }, + { + "style": "Include", + "text": "Superalgos->Node->Execution Started Event->Definition", + "updated": 1610105594875 + }, + { + "style": "Include", + "text": "Superalgos->Node->Execution Started Event->Content", + "updated": 1610105598223 + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Definition" + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Content" + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Definition" + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Content" + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Definition" + }, + { + "style": "Text", + "text": "Superalgos->Node->XXXXXXXX->Content" + } + ] +} \ No newline at end of file