diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-003-data-mining-dataset-types.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-003-data-mining-dataset-types.json index f5530d64d..fa499e5e5 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-003-data-mining-dataset-types.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-003-data-mining-dataset-types.json @@ -12,10 +12,14 @@ "text": "Dataset List", "updated": 1622052318412 }, + { + "style": "Title", + "text": "Dataset Types", + "updated": 1622227827875 + }, { "style": "Text", - "text": "This is the complete list of Dataset types currently supported by the system:", - "updated": 1622190817372 + "text": "This is the complete list of Dataset types currently supported by the system:" }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-004-data-mining-datasets-type-conversions.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-004-data-mining-datasets-type-conversions.json index f4d947865..1966efacd 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-004-data-mining-datasets-type-conversions.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-004-data-mining-datasets-type-conversions.json @@ -7,10 +7,14 @@ "updated": 1622205220555 }, "paragraphs": [ + { + "style": "Title", + "text": "Types of Dataset Conversions", + "updated": 1622227863425 + }, { "style": "Text", - "text": "The type of conversions currently implemented within the system are:", - "updated": 1622205237120 + "text": "The type of conversions currently implemented within the system are:" }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mine-hierarchy.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mine-hierarchy.json new file mode 100644 index 000000000..a5e39fae9 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mine-hierarchy.json @@ -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 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mines.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mines.json deleted file mode 100644 index 9e1a686cc..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-006-data-mining-data-mines.json +++ /dev/null @@ -1,86 +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": "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.", - "updated": 1622213888931 - }, - { - "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 - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-011-data-mining-deployments.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-011-data-mining-deployments.json index 785c63a7e..74a2d72f1 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-011-data-mining-deployments.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-011-data-mining-deployments.json @@ -3,19 +3,19 @@ "pageNumber": 11, "type": "Data Mining - Deployments", "definition": { - "text": "Data Minign Bots can be deployed into one or many machines at the same time and they will automatically find the way too coordinate their actions.", - "updated": 1621718512909 + "text": "Data Mining Bots can be deployed into one or many machines at the same time and they will automatically find the way too coordinate their actions.", + "updated": 1622225530181 }, "paragraphs": [ { "style": "Text", - "text": "Once you are done defining your data mining Bots, you can move the Tasks that execute them to other Network Nodes and some other node structures at the Network hierarchy and the bot's will still run even from different machines on the network.", - "updated": 1621719049976 + "text": "Once you are done defining your data mining Bots, you can move the Tasks that execute them to other Network Nodes and some other node structures within the Network hierarchy. The bot's will still run even from different machines on the network.", + "updated": 1622226742772 }, { "style": "Title", - "text": "How does Superalgos know how to coordinate Bots?", - "updated": 1621904714762 + "text": "How Does Superalgos Know How to Coordinate Bots?", + "updated": 1622226151968 }, { "style": "Text", @@ -24,26 +24,28 @@ }, { "style": "List", - "text": "In Data Mines: The definitions at the Data Mine contain the 3 types of relationships between Bots. Execution, Data Dependency and Status Dependency. " + "text": "In Data Mines: The definitions at the Data Mine contain the 3 types of relationships between Bots: Execution Dependency, Data Dependency and Status Dependency.", + "updated": 1622226774180 }, { "style": "List", - "text": "At the Network: The Network hierarchy contains all the information needed to know where the dependent bots are running (looking at the Tasks we can know at which machine in the network) and where the Datasets are in the network (looking at the Data Storage section)." + "text": "At the Network: The Network hierarchy contains all the information needed to know where the dependent bots are running. Looking at the Tasks on the network node, we can know which bots are running on a particular machine in the network. Looking at the Data Storage hierarchy, we can know where Datasets are being storied in the network.", + "updated": 1622226083877 }, { "style": "Title", - "text": "How does a Bot know where are it's dependencies running?", - "updated": 1621904824161 + "text": "How Does a Bot Know Where Its Dependencies are Running?", + "updated": 1622226168096 }, { "style": "Text", - "text": "Everytime a Task is executed, the whole Network hierarchy, together with the bot's definitions at Data Mines are sent to the Task Server. This includes not only the Bot to be ran definitions, but also all the definitions of the dependent bots. ", - "updated": 1621904939603 + "text": "Everytime a Task is executed, the whole Network hierarchy, together with the bot definitions at the Data Mines are sent to the Task Server. This includes not only the running Bot's definition, but also all the definitions of the dependent bots.", + "updated": 1622226410465 }, { "style": "Success", - "text": "At runtime, Superalgos will provide the Bot with the Datasets defined at Data Depencies, the Status Reports defined as Status Dependencies and if necesary, it iwll help the Bot wait for the Bot defined as an Execution Dependency, no matter where all those resources are within the physical network.", - "updated": 1621905102590 + "text": "At runtime, Superalgos will provide the Bot with the Datasets defined at Data Depencies, the Status Reports defined as Status Dependencies, and if necessary, it will help the Bot wait for the Bot defined as an Execution Dependency, no matter where all those resources are within the physical network.", + "updated": 1622226870002 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-012-data-mining-products.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-012-data-mining-products.json index 5f4c7d19a..a47b5dbd9 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-012-data-mining-products.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-012-data-mining-products.json @@ -3,14 +3,14 @@ "pageNumber": 12, "type": "Data Mining - Products", "definition": { - "text": "All Datasets of any type of bot within the Superalgos system are considered products of the Bot that produced them. Why products? Because users will be able to sell hese datasets in the form of subscriptions once the Superalgos Network is implemented.", - "updated": 1621905194343 + "text": "All Datasets of any type created by bots within the Superalgos system are considered data products of the Bot that produced them. Why products? Because users will be able to sell these datasets in the form of subscriptions once the Superalgos Network is implemented.", + "updated": 1622226983424 }, "paragraphs": [ { "style": "Text", - "text": "In the future, users will be able to offer products to the rest of the users of the Superalgos Network / Superalgos Marketplace. A single bot might produce as many products as the bot designer wishes. Each product might contain one or more datasets.", - "updated": 1621905284676 + "text": "In the future, users will be able to offer products to the rest of the users within the Superalgos Network / Superalgos Marketplace. A single bot might produce as many products as the bot designer wishes. Each product might contain one or more datasets.", + "updated": 1622227043268 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-013-data-mining-plotting.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-013-data-mining-plotting.json index b70e0d7d0..b5e8a953f 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-013-data-mining-plotting.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-013-data-mining-plotting.json @@ -3,14 +3,14 @@ "pageNumber": 13, "type": "Data Mining - Plotting", "definition": { - "text": "Each product might have one Plotter Module associated with it. This Plotter Module has all the definitions needed to interpret the Product's datasets and render the information at the charts.", - "updated": 1621905321330 + "text": "Each product may have one Plotter Module associated with it. This Plotter Module has all the definitions needed to interpret the Product's datasets and render the information on a chart.", + "updated": 1622227086801 }, "paragraphs": [ { "style": "Text", - "text": "Superalgos has the capability to allow it's users to create plotters without writing any code at all. The ploter is defined at the Designer Space, and by the means of defining vertices and polygons, users can create custom charts for any Dataset.", - "updated": 1621905478694 + "text": "Superalgos has the capability to allow it's users to create plotters without writing any code. The plotter is defined at the Designer Space. This is done by means of defining vertices and polygons. Users can create custom charts for any Dataset.", + "updated": 1622227235452 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-014-data-mining-fetching-data-from-apis.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-014-data-mining-fetching-data-from-apis.json index 2453faac6..74e5daafe 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-014-data-mining-fetching-data-from-apis.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-014-data-mining-fetching-data-from-apis.json @@ -3,8 +3,8 @@ "pageNumber": 14, "type": "Data Mining - Fetching Data From APIs", "definition": { - "text": "Superalgos allow it's users to fetch data from any API on the Internet without needing to write code to do it. Instead, users design an API Map, which is a set of definitions of how a Bot can access a certain API and how to interpret the API Server responses. With this API Maps, a API Data Fetcher Bot can be configured to extract data from any API Server and stored inside the system as Raw Data that later can processed and consumed by other Bots.", - "updated": 1621906349521 + "text": "Superalgos allows its users to fetch data from any API on the Internet without needing to write code. Instead, users design an API Map, which is a set of definitions for how a Bot can access a certain API and how to interpret the API Server responses. With this API Map, an API Data Fetcher Bot can be configured to extract data from any API Server and store Raw Data inside the system. This raw data can later be processed and consumed by other Bots.", + "updated": 1622228621778 }, "paragraphs": [ { @@ -14,24 +14,28 @@ }, { "style": "Title", - "text": "How to fetch data from an API?", - "updated": 1621951311144 + "text": "How to Fetch Data from an API?", + "updated": 1622228699547 }, { "style": "Text", - "text": "The main workflow to pull this out is quite straight forward and it does not require coding at all. Follow this guide and you will be using data from any source at the Internet from your trading strategies in no time." + "text": "The main workflow to pull this off is quite straight forward. It does not require coding at all. Follow this guide and you will be using data from any source on the Internet for your trading strategies in no time.", + "updated": 1622228741015 }, { "style": "List", - "text": "1. Choose an API: Current version is limited to public APIs only. Secured APIs comming soon. " + "text": "1. Choose an API: The current version is limited to public APIs only. Secured APIs coming soon.", + "updated": 1622229777229 }, { "style": "List", - "text": "2. Design an API Map: Read the APIs online documentation and identify the Endpoints that returns the data you would like to fetch. Carefully map those Endpoints defining the parameters the API Server expects at each call, and also how the API Server response is formatted." + "text": "2. Design an API Map: Read the APIs online documentation and identify the Endpoints that return the data you would like to fetch. Carefully map the Endpoints defining the parameters the API Server expects at each call, and also how the API Server response is formatted.", + "updated": 1622229840237 }, { "style": "List", - "text": "3. Setup an API Data Fetcher Bot: Create a Data Mine for this API and create there an API Data Fetcher Bot. From that Bot's Record Properties you will need to reference the fields returned by the API Server defined at the API Map, defining in this way which fields from each response you are going to save to disk. You might also need to define query or path parameters here. " + "text": "3. Setup an API Data Fetcher Bot: Create a Data Mine for this API and add an API Data Fetcher Bot. From that Bot's Record Properties you will need to reference the fields returned by the API Server defined at the API Map. This is how you define which fields from each response you are going to save to disk. You might also need to define query or path parameters here.", + "updated": 1622229993447 }, { "style": "List", @@ -40,11 +44,13 @@ }, { "style": "List", - "text": "5. Setup Indicator Bots: Once the data is converted, you can extract from it specific Datasets defining a set of indicators you can build from that data. These Indicators can be just a reorganization of the data, with some adjustments on the names of fields and splitting the data in different indicators, or it can also include some data processing / transformations if you wish (this would require some coding)." + "text": "5. Setup Indicator Bots: Once the data is converted, you can extract specific Datasets from it. These datasets can be used to define a set of indicators you can build from that data. These Indicators can be as simple as reorganizations of the data (with some adjustments to the names of fields and splitting the data into different indicators), or it can include some data processing / transformations if you wish (this would require some coding).", + "updated": 1622230478744 }, { "style": "List", - "text": "6. Setup Plotters: These last indicators can have their plotters if you wish." + "text": "6. Setup Plotters: After you have set up your indicators. You can design plotters for them if you wish.", + "updated": 1622230566915 }, { "style": "List", @@ -52,20 +58,18 @@ }, { "style": "Success", - "text": "There is a Workspace called API Data Fetcher Bot Demo with a simple working example of the previous steps you can take as reference." - }, - { - "style": "Block", - "text": "Data Aggregation" + "text": "There is a Workspace called API Data Fetcher Bot Demo with a simple working example of the previous steps you can use as a reference.", + "updated": 1622230619069 }, { "style": "Title", - "text": "How does data aggregation works?" + "text": "How Does Data Aggregation Work?", + "updated": 1622230634850 }, { "style": "Text", - "text": "When Raw Data is fetched from the Internet, it needs to be converted into a Dataset Type either of Multi-Time-Frame-Daily and Multi-Time-Frame-Market types. Usually Raw Data is a timestamped dataset with a timesStamp field or it has a begin and end properties if they are fragmented in time slots of one minute.", - "updated": 1621973202254 + "text": "When Raw Data is fetched from the Internet, it needs to be converted into a Dataset Type either of Multi-Time-Frame-Daily or Multi-Time-Frame-Market types. Usually Raw Data is a timestamped dataset with a timesStamp field, or it has begin and end properties if they are fragmented in time slots of one minute.", + "updated": 1622230917402 }, { "style": "Text", @@ -73,8 +77,8 @@ }, { "style": "Text", - "text": "At the Bot where this conversion happens, the Record Property nodes needs to have a config property agregattionMode that defines how this is going to be handled. Here is a list of the supported aggregated methods that can be used during this conversion procedure.", - "updated": 1621973294298 + "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", @@ -86,11 +90,13 @@ }, { "style": "List", - "text": "Min: This means that the mathematical minimun value from all values found in the time range will be used as the value for the Record Proeprty." + "text": "Min: This means that the mathematical minimum value from all values found in the time range will be used as the value for the Record Proeprty.", + "updated": 1622231381194 }, { "style": "List", - "text": "Max: This means that the mathematical maximun value from all values found in the time range will be used as the value for the Record Proeprty." + "text": "Max: This means that the mathematical maximum value from all values found in the time range will be used as the value for the Record Proeprty.", + "updated": 1622231375974 }, { "style": "List", @@ -100,13 +106,10 @@ "style": "List", "text": "Avg: This means that the average of all values found in the time range will be used as the value for the Record Proeprty." }, - { - "style": "Block", - "text": "Step By Step" - }, { "style": "Title", - "text": "Step by step guite to fetch data from an API" + "text": "Step by Step Guide to Fetch Data from an API", + "updated": 1622231458352 }, { "style": "Text", @@ -120,13 +123,13 @@ }, { "style": "List", - "text": "Step #2: Open a second UI (this will prevent the previous one to save the changes, but you don't need to do that). You will use the first UI to check from time to time how nodes are configured there, and the second UI to build your own data mining operation from scratch. The rest of the staps you will do it at the second UI.", - "updated": 1621976658929 + "text": "Step #2: Open a second UI (this will prevent the previous one from saving the changes, but you don't need to do that). You will use the first UI to check from time to time how nodes are configured there, and the second UI to build your own data mining operation from scratch. The rest of the steps you will do within the second UI.", + "updated": 1622231623225 }, { "style": "List", - "text": "Step #3: Select an API from the Internet with data that might be usefull at your Trading Strategy.", - "updated": 1621976668506 + "text": "Step #3: Select an API from the Internet with data that might be useful at your Trading Strategy.", + "updated": 1622231649073 }, { "style": "List", @@ -150,13 +153,13 @@ }, { "style": "List", - "text": "Step #8: Define one API Endpoint first, once you have the first one working, go for the rest of the enpoints available.", - "updated": 1621976699911 + "text": "Step #8: Define one API Endpoint first, once you have the first one working, go for the rest of the endpoints available.", + "updated": 1622231734738 }, { "style": "List", - "text": "Step #9: Define the query or path parameters and the the responses. Find at each node's help the details on how to do it right.", - "updated": 1621976710636 + "text": "Step #9: Define the query, or path parameters, and the responses. Read each node's help for details on how to do it right.", + "updated": 1622231862303 }, { "style": "List", @@ -165,18 +168,18 @@ }, { "style": "List", - "text": "Step #11: Create a new Data Mine woth the name of the company that host the API.", - "updated": 1621976722023 + "text": "Step #11: Create a new Data Mine with the name of the company that hosts the API.", + "updated": 1622231912331 }, { "style": "List", - "text": "Step #12: Create at that Data Mine and a API Data Fetcher Bot. Configure the Bot's nodes following the example at the UI #1.", - "updated": 1621976915804 + "text": "Step #12: Within the Data Mine add an API Data Fetcher Bot. Configure the Bot's nodes following the example at the UI #1.", + "updated": 1622231954570 }, { "style": "List", - "text": "Step #13: Install a new market. This procedure is going to setup many things for you. It will detect the API Map, and the Data Mine you created and will create appropiate Tasks to run your API Fertcher Bot.", - "updated": 1621976960858 + "text": "Step #13: Install a new market. This procedure is going to setup many things for you. It will detect the API Map, and the Data Mine you created and will create appropiate Tasks to run your API Fetcher Bot.", + "updated": 1622232103844 }, { "style": "List", @@ -184,7 +187,8 @@ }, { "style": "List", - "text": "Step #15: Define at your API Data Fetcher Bot Product Definition Record Properties the fields that you would like to save from the API Server response. You don't need to save everything, only what makes sense to you." + "text": "Step #15: At your API Data Fetcher Bot's Product Definition Record Properties, define the fields that you would like to save from the API Server response. You don't need to save everything, only what makes sense to you.", + "updated": 1622232590430 }, { "style": "List", @@ -192,12 +196,13 @@ }, { "style": "List", - "text": "Step #17: Pay attention to the special case of the needed timeStamp Record Property, specially because it might be pointing to the header of the API response. Read the docs of the API Response Field Reference node to set up the nodePath property if necesary." + "text": "Step #17: Pay attention to the special case of the required timeStamp Record Property. Specifically because it might be pointing to the header of the API response. Read the docs of the API Response Field Reference node to set up the nodePath property if necessary.", + "updated": 1622232714229 }, { "style": "List", - "text": "Step #18: Setup an your Data Mine an Indicator Bot and configure their Process Definition nodes to be of the framework that converts from One-Min-Daily to Multi-Time-Frame-Daily and Multi-Perio-Market types of Datasets. See how it was done at the UI #1.", - "updated": 1621977642805 + "text": "Step #18: At your Data Mine, set up an Indicator Bot and configure its Process Definition nodes to the framework that will convert from One-Min-Daily to Multi-Time-Frame-Daily and Multi-Perio-Market types of Datasets. See how it was done at the UI #1.", + "updated": 1622232795794 }, { "style": "List", @@ -205,11 +210,13 @@ }, { "style": "List", - "text": "Step #20: Configure at each Record Proeprty the aggregationMode property. Check the docs of that node for details." + "text": "Step #20: Configure the aggregationMethod property for each Record Property. Check the docs of that node for details.", + "updated": 1622235178187 }, { "style": "List", - "text": "Step #21: If you wish you can create multiple other Indicator Bots to cut the dataset in different groups of Record Properties." + "text": "Step #21: If you wish, you can create multiple Indicator Bots to cut the dataset in different groups of Record Properties.", + "updated": 1622233072603 }, { "style": "List", @@ -225,24 +232,28 @@ }, { "style": "List", - "text": "Step #25: Iterate through step #24 until everything is working. Re read node's documentations until you get the details of what it explains there. Reread this guide or this whole Topic from the start, until the concepts explained sinks in. " + "text": "Step #25: Iterate through step #24 until everything is working. Re read node's documentation until you get the details of what it explains there. Reread this guide or this whole Topic from the start, until the concepts explained sinks in.", + "updated": 1622233708371 }, { "style": "List", - "text": "Step #26: If after digesting the docs, and following all this advice you stil can not put it to work, go to the Telegram Support group and ask for help." + "text": "Step #26: If after digesting the docs, and following all this advice you still cannot get it to work, go to the Telegram Support group and ask for help.", + "updated": 1622233735826 }, { "style": "List", - "text": "Step #27: Once all is running well, set up your Trading Stragegy in a way that allows you to test if you have acces to the prcessed data, the one provided by the latest Indicator Bots created." + "text": "Step #27: Once all is running well, set up your Trading Strategy in a way that allows you to test if you have access to the processed data (the one provided by the latest Indicator Bots created).", + "updated": 1622233777598 }, { "style": "List", - "text": "Step #29: Once the data is correctly consumed by your Trading Strategy iterate throug this guide by adding another API Endpoint to the API Map. You will need for that a new API Fetcher Bot.", - "updated": 1621978484377 + "text": "Step #29: Once the data is correctly consumed by your Trading Strategy, iterate through this guide by adding another API Endpoint to the API Map. You will need to add an addtional API Fetcher Bot.", + "updated": 1622233824073 }, { "style": "List", - "text": "Step #30: Once you have sucessfully mapped the whole API and you have all the needed API Data Fetcher, Indicator Bots and Plotters tested, you are ready to share your API Map and Data Mine with the community as plugins, and get in exchange SA tokens for your contribution. " + "text": "Step #30: Once you have successfully mapped the whole API and you have all the needed API Data Fetchers, Indicator Bots and Plotters tested, you are ready to share your API Map and Data Mine with the community as a plugin, and receive SA tokens in exchange for your contribution.", + "updated": 1622233875203 }, { "style": "Text", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-015-data-mining-consuming-data-from-strategies.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-015-data-mining-consuming-data-from-strategies.json index e20c27ce4..cb830f7fa 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-015-data-mining-consuming-data-from-strategies.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-015-data-mining-consuming-data-from-strategies.json @@ -3,13 +3,14 @@ "pageNumber": 15, "type": "Data Mining - Consuming Data From Strategies", "definition": { - "text": "Traing Bots can have as Data Dependencies datasets from any Indicator Bots. This allows Trading Strategies to act upon the data processed by Indicator Bots.", - "updated": 1621721963137 + "text": "Trading Bots can have Data Dependencies from any Indicator Bot that puts out data products. This allows Trading Strategies to act upon the data processed by Indicator Bots.", + "updated": 1622234087314 }, "paragraphs": [ { "style": "Text", - "text": "Right click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode. Then you can use docs.save to save your changes and app.contribute to send it to the main repository." + "text": "This is the heart and soul of the data mining process allowing users to create trading bots that act upon sophisticated data and data analysis logic.", + "updated": 1622234159617 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-data-mine-hierarchy.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-data-mine-hierarchy.json deleted file mode 100644 index 8a8ae8586..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-data-mine-hierarchy.json +++ /dev/null @@ -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 - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-indicator-bots.json similarity index 97% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-indicator-bots.json index 2b6aa9582..aeb8d3501 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-016-data-mining-indicator-bots.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-process-definition.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots-process-definition.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-process-definition.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots-process-definition.json index 5afaddf9e..515fd59b8 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-process-definition.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-017-data-mining-indicator-bots-process-definition.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-product-definition.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-product-definition.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-product-definition.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-product-definition.json index e57f52673..9688b4236 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-product-definition.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-018-data-mining-indicator-bots-product-definition.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-data-mining-workflow.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-data-mining-workflow.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-data-mining-workflow.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-data-mining-workflow.json index da2d5ca67..60ed263a8 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-data-mining-workflow.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-019-data-mining-indicator-bots-data-mining-workflow.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-indicator-bots-coding-the-indicators-logic.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-coding-the-indicators-logic.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-indicator-bots-coding-the-indicators-logic.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-coding-the-indicators-logic.json index f148091bc..047ac9527 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-indicator-bots-coding-the-indicators-logic.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-020-data-mining-indicator-bots-coding-the-indicators-logic.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-plotters.json similarity index 98% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-plotters.json index 4f0161565..08fa4da9a 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-021-data-mining-plotters.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-plotters-shapes.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters-shapes.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-plotters-shapes.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters-shapes.json index 1257acb9f..10f5d1f07 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-plotters-shapes.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-022-data-mining-plotters-shapes.json @@ -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.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-024-data-mining-how-to-build-an-indicator-video-series.json b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-how-to-build-an-indicator-video-series.json similarity index 99% rename from Projects/Superalgos/Schemas/Docs-Topics/data-mining-024-data-mining-how-to-build-an-indicator-video-series.json rename to Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-how-to-build-an-indicator-video-series.json index 32d4e3111..70c248555 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/data-mining-024-data-mining-how-to-build-an-indicator-video-series.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/data-mining-023-data-mining-how-to-build-an-indicator-video-series.json @@ -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.",