v6-average-py/algorithm_store.json at master · vantage6/v6-average-py · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "name": "Demo - Average",
  "image": "ghcr.io/vantage6/algorithm/demo/average",
  "vantage6_version": "5.0.0",
  "code_url": "https://github.com/vantage6/v6-average-py",
  "documentation_url": "",
  "partitioning": "horizontal",
  "description": "Compute the average of a selected column in a federated way.",
  "functions": [
    {
      "name": "central_average",
      "display_name": "Central average",
      "standalone": true,
      "description": "Compute the global average of a column across all participating organizations.",
      "step_type": "central_compute",
      "ui_visualizations": [],
      "arguments": [
        {
          "name": "column_name",
          "display_name": "Column",
          "description": "Column for which to compute the global average",
          "type": "column",
          "has_default_value": false,
          "is_frontend_only": false
        }
      ],
      "databases": [
        {
          "name": "Database",
          "description": "Database to use for the average computation"
        }
      ]
    },
    {
      "name": "partial_average",
      "display_name": "Partial average",
      "standalone": true,
      "description": "Compute local sum and row count for a single organization.",
      "step_type": "federated_compute",
      "ui_visualizations": [],
      "arguments": [
        {
          "name": "column_name",
          "display_name": "Column",
          "description": "Column for which to compute the local sum and count",
          "type": "column",
          "has_default_value": false,
          "is_frontend_only": false
        }
      ],
      "databases": [
        {
          "name": "Database",
          "description": "Database to use for the partial average computation"
        }
      ]
    }
  ]
}