dora-rs
/
dora
Not watched
1
0
Fork 0
Code
Releases 124 Wiki evaluate Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain HPC
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 558fa14907
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '558fa14907'
${ noResults }
dora/libraries/core/dora-schema.json

523 lines
11 kB
Raw Blame History 

  1. {

  2.   "$schema": "http://json-schema.org/draft-07/schema#",

  3.   "title": "dora-rs specification",

  4.   "description": "Dataflow description",

  5.   "type": "object",

  6.   "required": [

  7.     "nodes"

  8.   ],

  9.   "properties": {

  10.     "_unstable_deploy": {

  11.       "default": {

  12.         "machine": null

  13.       },

  14.       "allOf": [

  15.         {

  16.           "$ref": "#/definitions/Deploy"

  17.         }

  18.       ]

  19.     },

  20.     "communication": {

  21.       "default": {

  22.         "_unstable_local": "Tcp",

  23.         "_unstable_remote": "tcp"

  24.       },

  25.       "allOf": [

  26.         {

  27.           "$ref": "#/definitions/CommunicationConfig"

  28.         }

  29.       ]

  30.     },

  31.     "nodes": {

  32.       "type": "array",

  33.       "items": {

  34.         "$ref": "#/definitions/Node"

  35.       }

  36.     }

  37.   },

  38.   "additionalProperties": true,

  39.   "definitions": {

  40.     "CommunicationConfig": {

  41.       "type": "object",

  42.       "properties": {

  43.         "_unstable_local": {

  44.           "default": "Tcp",

  45.           "type": "string"

  46.         },

  47.         "_unstable_remote": {

  48.           "default": "tcp",

  49.           "type": "string"

  50.         }

  51.       },

  52.       "additionalProperties": true

  53.     },

  54.     "CustomNode": {

  55.       "type": "object",

  56.       "required": [

  57.         "source"

  58.       ],

  59.       "properties": {

  60.         "args": {

  61.           "description": "Args for the executable.",

  62.           "type": [

  63.             "string",

  64.             "null"

  65.           ]

  66.         },

  67.         "build": {

  68.           "type": [

  69.             "string",

  70.             "null"

  71.           ]

  72.         },

  73.         "envs": {

  74.           "description": "Environment variables for the custom nodes",

  75.           "type": [

  76.             "object",

  77.             "null"

  78.           ],

  79.           "additionalProperties": {

  80.             "$ref": "#/definitions/EnvValue"

  81.           }

  82.         },

  83.         "inputs": {

  84.           "description": "Inputs for the nodes as a map from input ID to input configuration\n\ne.g.\n\ninputs:\n\nexample_input: example_node/example_output1",

  85.           "default": {},

  86.           "type": "object",

  87.           "additionalProperties": true

  88.         },

  89.         "outputs": {

  90.           "description": "Outputs as a list of outputs.\n\ne.g.\n\noutputs:\n\n- output_1\n\n- output_2",

  91.           "default": [],

  92.           "type": "array",

  93.           "items": {

  94.             "$ref": "#/definitions/DataId"

  95.           },

  96.           "uniqueItems": true

  97.         },

  98.         "send_stdout_as": {

  99.           "description": "Send stdout and stderr to another node",

  100.           "type": [

  101.             "string",

  102.             "null"

  103.           ]

  104.         },

  105.         "source": {

  106.           "description": "Path of the source code\n\nIf you want to use a specific `conda` environment. Provide the python path within the source.\n\nsource: /home/peter/miniconda3/bin/python\n\nargs: some_node.py\n\nSource can match any executable in PATH.",

  107.           "type": "string"

  108.         }

  109.       }

  110.     },

  111.     "DataId": {

  112.       "type": "string"

  113.     },

  114.     "Deploy": {

  115.       "type": "object",

  116.       "properties": {

  117.         "machine": {

  118.           "type": [

  119.             "string",

  120.             "null"

  121.           ]

  122.         }

  123.       },

  124.       "additionalProperties": true

  125.     },

  126.     "Duration": {

  127.       "type": "object",

  128.       "required": [

  129.         "nanos",

  130.         "secs"

  131.       ],

  132.       "properties": {

  133.         "nanos": {

  134.           "type": "integer",

  135.           "format": "uint32",

  136.           "minimum": 0.0

  137.         },

  138.         "secs": {

  139.           "type": "integer",

  140.           "format": "uint64",

  141.           "minimum": 0.0

  142.         }

  143.       }

  144.     },

  145.     "EnvValue": {

  146.       "anyOf": [

  147.         {

  148.           "type": "boolean"

  149.         },

  150.         {

  151.           "type": "integer",

  152.           "format": "uint64",

  153.           "minimum": 0.0

  154.         },

  155.         {

  156.           "type": "string"

  157.         }

  158.       ]

  159.     },

  160.     "Input": {

  161.       "type": "object",

  162.       "required": [

  163.         "mapping"

  164.       ],

  165.       "properties": {

  166.         "mapping": {

  167.           "$ref": "#/definitions/InputMapping"

  168.         },

  169.         "queue_size": {

  170.           "type": [

  171.             "integer",

  172.             "null"

  173.           ],

  174.           "format": "uint",

  175.           "minimum": 0.0

  176.         }

  177.       },

  178.       "additionalProperties": true

  179.     },

  180.     "InputMapping": {

  181.       "oneOf": [

  182.         {

  183.           "type": "object",

  184.           "required": [

  185.             "Timer"

  186.           ],

  187.           "properties": {

  188.             "Timer": {

  189.               "type": "object",

  190.               "required": [

  191.                 "interval"

  192.               ],

  193.               "properties": {

  194.                 "interval": {

  195.                   "$ref": "#/definitions/Duration"

  196.                 }

  197.               }

  198.             }

  199.           },

  200.           "additionalProperties": true

  201.         },

  202.         {

  203.           "type": "object",

  204.           "required": [

  205.             "User"

  206.           ],

  207.           "properties": {

  208.             "User": {

  209.               "$ref": "#/definitions/UserInputMapping"

  210.             }

  211.           },

  212.           "additionalProperties": true

  213.         }

  214.       ]

  215.     },

  216.     "Node": {

  217.       "description": "Dora Node",

  218.       "type": "object",

  219.       "oneOf": [

  220.         {

  221.           "description": "Dora runtime node",

  222.           "type": "object",

  223.           "required": [

  224.             "operators"

  225.           ],

  226.           "properties": {

  227.             "operators": {

  228.               "type": "array",

  229.               "items": {

  230.                 "$ref": "#/definitions/OperatorDefinition"

  231.               }

  232.             }

  233.           },

  234.           "additionalProperties": true

  235.         },

  236.         {

  237.           "type": "object",

  238.           "required": [

  239.             "custom"

  240.           ],

  241.           "properties": {

  242.             "custom": {

  243.               "$ref": "#/definitions/CustomNode"

  244.             }

  245.           },

  246.           "additionalProperties": true

  247.         },

  248.         {

  249.           "type": "object",

  250.           "required": [

  251.             "operator"

  252.           ],

  253.           "properties": {

  254.             "operator": {

  255.               "$ref": "#/definitions/SingleOperatorDefinition"

  256.             }

  257.           },

  258.           "additionalProperties": true

  259.         }

  260.       ],

  261.       "required": [

  262.         "id"

  263.       ],

  264.       "properties": {

  265.         "_unstable_deploy": {

  266.           "description": "Unstable machine deployment configuration",

  267.           "default": {

  268.             "machine": null

  269.           },

  270.           "allOf": [

  271.             {

  272.               "$ref": "#/definitions/Deploy"

  273.             }

  274.           ]

  275.         },

  276.         "description": {

  277.           "description": "Description of the node",

  278.           "type": [

  279.             "string",

  280.             "null"

  281.           ]

  282.         },

  283.         "env": {

  284.           "description": "Environment variables",

  285.           "type": [

  286.             "object",

  287.             "null"

  288.           ],

  289.           "additionalProperties": {

  290.             "$ref": "#/definitions/EnvValue"

  291.           }

  292.         },

  293.         "id": {

  294.           "description": "Node identifier",

  295.           "allOf": [

  296.             {

  297.               "$ref": "#/definitions/NodeId"

  298.             }

  299.           ]

  300.         },

  301.         "name": {

  302.           "description": "Node name",

  303.           "type": [

  304.             "string",

  305.             "null"

  306.           ]

  307.         }

  308.       }

  309.     },

  310.     "NodeId": {

  311.       "type": "string"

  312.     },

  313.     "OperatorDefinition": {

  314.       "type": "object",

  315.       "oneOf": [

  316.         {

  317.           "type": "object",

  318.           "required": [

  319.             "shared-library"

  320.           ],

  321.           "properties": {

  322.             "shared-library": {

  323.               "type": "string"

  324.             }

  325.           },

  326.           "additionalProperties": true

  327.         },

  328.         {

  329.           "type": "object",

  330.           "required": [

  331.             "python"

  332.           ],

  333.           "properties": {

  334.             

  335.           },

  336.           "additionalProperties": true

  337.         },

  338.         {

  339.           "type": "object",

  340.           "required": [

  341.             "wasm"

  342.           ],

  343.           "properties": {

  344.             "wasm": {

  345.               "type": "string"

  346.             }

  347.           },

  348.           "additionalProperties": true

  349.         }

  350.       ],

  351.       "required": [

  352.         "id"

  353.       ],

  354.       "properties": {

  355.         "build": {

  356.           "type": [

  357.             "string",

  358.             "null"

  359.           ]

  360.         },

  361.         "description": {

  362.           "type": [

  363.             "string",

  364.             "null"

  365.           ]

  366.         },

  367.         "id": {

  368.           "$ref": "#/definitions/OperatorId"

  369.         },

  370.         "inputs": {

  371.           "default": {},

  372.           "type": "object",

  373.           "additionalProperties": true

  374.         },

  375.         "name": {

  376.           "type": [

  377.             "string",

  378.             "null"

  379.           ]

  380.         },

  381.         "outputs": {

  382.           "default": [],

  383.           "type": "array",

  384.           "items": {

  385.             "$ref": "#/definitions/DataId"

  386.           },

  387.           "uniqueItems": true

  388.         },

  389.         "send_stdout_as": {

  390.           "type": [

  391.             "string",

  392.             "null"

  393.           ]

  394.         }

  395.       }

  396.     },

  397.     "OperatorId": {

  398.       "type": "string"

  399.     },

  400.     "PythonSource": {

  401.       "type": "object",

  402.       "required": [

  403.         "source"

  404.       ],

  405.       "properties": {

  406.         "conda_env": {

  407.           "type": [

  408.             "string",

  409.             "null"

  410.           ]

  411.         },

  412.         "source": {

  413.           "type": "string"

  414.         }

  415.       },

  416.       "additionalProperties": true

  417.     },

  418.     "SingleOperatorDefinition": {

  419.       "type": "object",

  420.       "oneOf": [

  421.         {

  422.           "type": "object",

  423.           "required": [

  424.             "shared-library"

  425.           ],

  426.           "properties": {

  427.             "shared-library": {

  428.               "type": "string"

  429.             }

  430.           },

  431.           "additionalProperties": true

  432.         },

  433.         {

  434.           "type": "object",

  435.           "required": [

  436.             "python"

  437.           ],

  438.           "properties": {

  439.             

  440.           },

  441.           "additionalProperties": true

  442.         },

  443.         {

  444.           "type": "object",

  445.           "required": [

  446.             "wasm"

  447.           ],

  448.           "properties": {

  449.             "wasm": {

  450.               "type": "string"

  451.             }

  452.           },

  453.           "additionalProperties": true

  454.         }

  455.       ],

  456.       "properties": {

  457.         "build": {

  458.           "type": [

  459.             "string",

  460.             "null"

  461.           ]

  462.         },

  463.         "description": {

  464.           "type": [

  465.             "string",

  466.             "null"

  467.           ]

  468.         },

  469.         "id": {

  470.           "description": "ID is optional if there is only a single operator.",

  471.           "anyOf": [

  472.             {

  473.               "$ref": "#/definitions/OperatorId"

  474.             },

  475.             {

  476.               "type": "null"

  477.             }

  478.           ]

  479.         },

  480.         "inputs": {

  481.           "default": {},

  482.           "type": "object",

  483.           "additionalProperties": true

  484.         },

  485.         "name": {

  486.           "type": [

  487.             "string",

  488.             "null"

  489.           ]

  490.         },

  491.         "outputs": {

  492.           "default": [],

  493.           "type": "array",

  494.           "items": {

  495.             "$ref": "#/definitions/DataId"

  496.           },

  497.           "uniqueItems": true

  498.         },

  499.         "send_stdout_as": {

  500.           "type": [

  501.             "string",

  502.             "null"

  503.           ]

  504.         }

  505.       }

  506.     },

  507.     "UserInputMapping": {

  508.       "type": "object",

  509.       "required": [

  510.         "output",

  511.         "source"

  512.       ],

  513.       "properties": {

  514.         "output": {

  515.           "$ref": "#/definitions/DataId"

  516.         },

  517.         "source": {

  518.           "$ref": "#/definitions/NodeId"

  519.         }

  520.       }

  521.     }

  522.   }

  523. }