Finish initial edit of data mining docs
This commit is contained in:
Brenden Harrell committed
1 parent
4a885047a5
commit
0edf17e5f1
12 files changed
+190
-208
No files matched your search
+178
@@ -0,0 +1,178 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 6,
|
||||
"type": "Data Mining - Data Mine Hierarchy",
|
||||
"definition": {
|
||||
"text": "Data mines enable the processing of data by consuming datasets others have produced, performing calculations, and outputting a new value-added data product that others may consume. In other words, Data Mines are user created packages of definitions. These definitions usually include Sensor Bot, Indicator Bot and Plotter definitions. The Data Mines shipped with Superalgos are packages contributed by users of the software.",
|
||||
"updated": 1622238150464
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Superalgos puts a powerful data processing and visualization system into your hands. Use it to the fullest and you will see your intelligence increase by orders of magnitude.",
|
||||
"updated": 1622235471834
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Anyone may access raw trades and order book data from exchanges. Anyone may access information in the form of standard indicators and technical studies."
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "However, Superalgos allows you to perform any sort of processing over existing information across the whole span of the market, store the results into new datasets, and make them available to trading strategies. Moreover, it allows you to produce elaborate graphical representations of data, which is instantly browsable over the charts."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data mines’ functionality is highly flexible and works under the same paradigm used for building strategies. They provide a visual interface and a framework that leads you through the process of creating new bots, with minimal coding skills required."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The vast majority of the complexity of processing data is handled internally by the bots, and you don’t need to deal with it or even understand it. The system isolates complexity and only exposes you to the crucial elements that impact what you wish to accomplish."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "This section of the documentation provides you with the technical understanding of how data is handled by the system. The core of the functionality this section unveils covers—in essence—the following points:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The capacity to define any number of calculation processes that may feed on each other’s outputs, resulting in a wealth of information that may be consumed by trading strategies."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The properties and characteristics of datasets resulting from the execution of such processes—how and where they are stored, in what format, how they are consumed internally, and potentially, by other systems."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The capacity to visualize the data over the charts and browse it with all the features built in to the charting system.",
|
||||
"updated": 1622235587518
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "How Bots Use Data Mines"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It is important to undestand that a Data Mine is a package of definitions. When users run a Bot, they do it inside a Task. This task needs to know how to run the bot. In order to find this out, the bot within the task must have a reference to a Process Definition exisiting at a Data Mine. When the bot is launched inside the task, at that moment, it receives all the information regarding the task that is being used to launch the bot, while at the same time it also receives the information regarding the Bot's definition from the Data Mine."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Using both sides of this information (Task data and Bot definition) the Bot is able to do it's job.",
|
||||
"updated": 1622238315541
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Who Creates Data Mines?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data Mines are created by power users and contributed to the project (the ones shipping with the software). Users might create Data Mines for their personal use and never share them. However, if they share them, they receive SA tokens for that, and also for adapting and mantaining them, if necessary, for each new release."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Supported Bots"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There are three types of bots that can hold their definitions at a Data Mine."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Sensor Bots: used to fetch data from some Internet source by coding a specialized algorithm."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "API Data Fetcher Bots: used to fetch data from an Internet API without needing to code."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Indicator Bots: used to process data."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Data Mine",
|
||||
"updated": 1611407778880
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Data Mine->Definition",
|
||||
"updated": 1611407782909
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Data Mine->Content",
|
||||
"updated": 1611407786577
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables No Discussion"
|
||||
},
|
||||
{
|
||||
"style": "Hierarchy",
|
||||
"text": "Superalgos->Data Mine->2",
|
||||
"updated": 1611407832651
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Sensor Bot",
|
||||
"updated": 1611407910652
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Sensor Bot->Definition",
|
||||
"updated": 1611407914247
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Indicator Bot",
|
||||
"updated": 1611407935038
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Indicator Bot->Definition",
|
||||
"updated": 1611407948292
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Plotter",
|
||||
"updated": 1611407956192
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Plotter->Definition",
|
||||
"updated": 1611407972840
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Interdependency of Data Mines"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data Mines might depend on other Data Mines. What this means is the bots within a Data Mine may depend on bots belonging to other Data Mines. Further on in this Topic, you will learn more about how a bot can depend on other bots in detail. In a nutshell, they can depend in 3 ways. They can have a:"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Data Dependency: This means that a Bot uses as an input the data produced by another bot."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Status Dependency: This means that a Bot uses the status of another Bot as parameters for it's own processing."
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "The most common use case is when a Bot needs the date on which a market starts or ends. This information is automatically fetched from the Status Report of the bot that produces the raw data because it knows which data is the oldest and the newest at all times.",
|
||||
"updated": 1622237821439
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Execution Dependency: This means that a Bot depends on other Bot execution to finish in order for it to start it's own execution."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "When a Data Mine depends on another Data Mine, both need to be present at the Workspace where the Task executing the Bot is located.",
|
||||
"updated": 1622237827110
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,90 +0,0 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 6,
|
||||
"type": "Data Mining - Data Mines",
|
||||
"definition": {
|
||||
"text": "Data Mines are user created packages of definitions. These definitions usually include Sensor Bot, Indicator Bot and Plotter definitions. The Data Mines shipped with Superalgos are packages contributed by users of the software.",
|
||||
"updated": 1621708561783
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "How Bots Use Data Mines",
|
||||
"updated": 1622228000451
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It is important to undestand that a Data Mine is a package of definitions. When users run a Bot, they do it inside a Task. This task needs to know how to run the bot. In order to find this out, the bot within the task must have a reference to a Process Definition exisiting at a Data Mine. When the bot is launched inside the task, at that moment, it receives all the information regarding the task that is being used to launch the bot, while at the same time it also receives the information regarding the Bot's definition from the Data Mine."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Using both sides of this information (Task data and Bot definition) the Bot is able to do it's job.",
|
||||
"updated": 1622213831832
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Who Creates Data Mines?",
|
||||
"updated": 1622213931643
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data Mines are created by power users and contributed to the project (the ones shipping with the software). Users might create Data Mines for their personal use and never share them. However, if they share them, they receive SA tokens for that, and also for adapting and mantaining them, if necessary, for each new release.",
|
||||
"updated": 1622214117754
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Supported Bots"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There are three types of bots that can hold their definitions at a Data Mine."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Sensor Bots: used to fetch data from some Internet source by coding a specialized algorithm.",
|
||||
"updated": 1622214170520
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "API Data Fetcher Bots: used to fetch data from an Internet API without needing to code."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Indicator Bots: used to process data."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Interdependency of Data Mines",
|
||||
"updated": 1621709799491
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data Mines might depend on other Data Mines. What this means is the bots within a Data Mine may depend on bots belonging to other Data Mines. Further on in this Topic, you will learn more about how a bot can depend on other bots in detail. In a nutshell, they can depend in 3 ways. They can have a:",
|
||||
"updated": 1622214335992
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Data Dependency: This means that a Bot uses as an input the data produced by another bot."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Status Dependency: This means that a Bot uses the status of another Bot as parameters for it's own processing.",
|
||||
"updated": 1622214428120
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "The most common use case is when a Bot needs the date on which a market starts or ends. This information is automatically fetched from the Status Report of the bot that produces the raw data because it knows which data is the oldest and the newest at all times.",
|
||||
"updated": 1622214512428
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Execution Dependency: This means that a Bot depends on other Bot execution to finish in order for it to start it's own execution.",
|
||||
"updated": 1621709849717
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "When a Data Mine depends on another Data Mine, both need to be present at the Workspace where the Task executing the Bot is located.",
|
||||
"updated": 1622214646178
|
||||
}
|
||||
]
|
||||
}
|
||||
+4
-4
@@ -77,8 +77,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "At the Bot where this conversion happens, the Record Property nodes needs to have an agregattionMode config property that defines how this is going to be handled. Here is a list of the supported aggregation methods that can be used during this conversion procedure:",
|
||||
"updated": 1622231250739
|
||||
"text": "At the Bot where this conversion happens, the Record Property nodes needs to have an aggregationMethod config property that defines how this is going to be handled. Here is a list of the supported aggregation methods that can be used during this conversion procedure:",
|
||||
"updated": 1622235156415
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
@@ -210,8 +210,8 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Step #20: Configure the aggregationMode property for each Record Property. Check the docs of that node for details.",
|
||||
"updated": 1622233036019
|
||||
"text": "Step #20: Configure the aggregationMethod property for each Record Property. Check the docs of that node for details.",
|
||||
"updated": 1622235178187
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
|
||||
-106
@@ -1,106 +0,0 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 16,
|
||||
"type": "Data Mining - Data Mine Hierarchy",
|
||||
"definition": {
|
||||
"text": "Data mines enable the processing of data by consuming datasets others have produced, performing calculations, and outputting a new value-added data product that others may consume.",
|
||||
"updated": 1611407680590
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Superalgos puts a powerful data processing and visualization system in your hands. Use it to the fullest and you will see your intelligence increase by orders of magnitude.",
|
||||
"updated": 1611407700153
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Anyone may access raw trades and order book data from exchanges. Anyone may access information in the form of standard indicators and technical studies."
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "However, Superalgos allows you to perform any sort of processing over existing information across the whole span of the market, store the results into new datasets, and make them available to trading strategies. Moreover, it allows you to produce elaborate graphical representations of data, which is instantly browsable over the charts."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data mines’ functionality is highly flexible and works under the same paradigm used for building strategies. They provide a visual interface and a framework that leads you through the process of creating new bots, with minimal coding skills required."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The vast majority of the complexity of processing data is handled internally by the bots, and you don’t need to deal with it or even understand it. The system isolates complexity and only exposes you to the crucial elements that impact what you wish to accomplish."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "This section of the documentation provides you with the technical understanding of how data is handled by the system. The core of the functionality this section unveils covers—in essence—the following points:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The capacity to define any number of calculation processes that may feed on each other’s outputs, resulting in a wealth of information that may be consumed by trading strategies."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The properties and characteristics of datasets resulting from the execution of such processes—how and where they are stored, in what format, how they are consumed internally, and potentially, by other systems."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The capacity to visualize the data over the charts and browse it with all the features built in the charting system."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Data Mine",
|
||||
"updated": 1611407778880
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Data Mine->Definition",
|
||||
"updated": 1611407782909
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Data Mine->Content",
|
||||
"updated": 1611407786577
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables No Discussion"
|
||||
},
|
||||
{
|
||||
"style": "Hierarchy",
|
||||
"text": "Superalgos->Data Mine->2",
|
||||
"updated": 1611407832651
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Sensor Bot",
|
||||
"updated": 1611407910652
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Sensor Bot->Definition",
|
||||
"updated": 1611407914247
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Indicator Bot",
|
||||
"updated": 1611407935038
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Indicator Bot->Definition",
|
||||
"updated": 1611407948292
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Plotter",
|
||||
"updated": 1611407956192
|
||||
},
|
||||
{
|
||||
"style": "Include",
|
||||
"text": "Superalgos->Node->Plotter->Definition",
|
||||
"updated": 1611407972840
|
||||
}
|
||||
]
|
||||
}
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 17,
|
||||
"pageNumber": 16,
|
||||
"type": "Data Mining - Indicator Bots",
|
||||
"definition": {
|
||||
"text": "Indicator bots enable the processing of data by consuming datasets others have produced, performing calculations, and outputting a new value-added data product that others may consume.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 18,
|
||||
"pageNumber": 17,
|
||||
"type": "Data Mining - Indicator Bots - Process Definition",
|
||||
"definition": {
|
||||
"text": "The process definition is the compilation of configurations, dependencies, and references that make up a process.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 19,
|
||||
"pageNumber": 18,
|
||||
"type": "Data Mining - Indicator Bots - Product Definition",
|
||||
"definition": {
|
||||
"text": "The product definition is the compilation of configurations, references, and JavaScript code that make up the data product.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 20,
|
||||
"pageNumber": 19,
|
||||
"type": "Data Mining - Indicator Bots - Data Mining Workflow",
|
||||
"definition": {
|
||||
"text": "When running on a data mining operation, indicators follow a cycle designed to fulfill their purpose: to process data others have produced and make the result available for others to consume.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 21,
|
||||
"pageNumber": 20,
|
||||
"type": "Data Mining - Indicator Bots - Coding the Indicator's Logic",
|
||||
"definition": {
|
||||
"text": "Learn how to use data dependencies, the variable object, and how to deal with indicators with irregular periods.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 22,
|
||||
"pageNumber": 21,
|
||||
"type": "Data Mining - Plotters",
|
||||
"definition": {
|
||||
"text": "Plotters read data products created by bots and map certain coordinate points to use them as vertices for polygons, which are assigned styles to create graphic representations of the underlying data.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 23,
|
||||
"pageNumber": 22,
|
||||
"type": "Data Mining - Plotters - Shapes",
|
||||
"definition": {
|
||||
"text": "Shapes define coordinate points to use as vertex for polygons, which are assigned styles.",
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"topic": "Data Mining",
|
||||
"pageNumber": 24,
|
||||
"pageNumber": 23,
|
||||
"type": "Data Mining - How to Build an Indicator - Video Series",
|
||||
"definition": {
|
||||
"text": "This video series goes through the entire process of building an indicator, step by step.",
|
||||
Reference in new issue
Block a user