vantage6 4.4.0rc3__py3-none-any.whl → 4.5.0rc3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of vantage6 might be problematic. Click here for more details.
- vantage6/cli/__init__.py +2 -0
- vantage6/cli/_version.py +1 -1
- {vantage6-4.4.0rc3.dist-info → vantage6-4.5.0rc3.dist-info}/METADATA +43 -34
- {vantage6-4.4.0rc3.dist-info → vantage6-4.5.0rc3.dist-info}/RECORD +7 -7
- {vantage6-4.4.0rc3.dist-info → vantage6-4.5.0rc3.dist-info}/WHEEL +0 -0
- {vantage6-4.4.0rc3.dist-info → vantage6-4.5.0rc3.dist-info}/entry_points.txt +0 -0
- {vantage6-4.4.0rc3.dist-info → vantage6-4.5.0rc3.dist-info}/top_level.txt +0 -0
vantage6/cli/__init__.py
CHANGED
vantage6/cli/_version.py
CHANGED
|
@@ -7,7 +7,7 @@ with open(os.path.join(here, "__build__")) as fp:
|
|
|
7
7
|
__build__ = json.load(fp)
|
|
8
8
|
|
|
9
9
|
# Module version
|
|
10
|
-
version_info = (4,
|
|
10
|
+
version_info = (4, 5, 0, "candidate", __build__, 0)
|
|
11
11
|
|
|
12
12
|
# Module version stage suffix map
|
|
13
13
|
_specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: vantage6
|
|
3
|
-
Version: 4.
|
|
3
|
+
Version: 4.5.0rc3
|
|
4
4
|
Summary: vantage6 command line interface
|
|
5
5
|
Home-page: https://github.com/vantage6/vantage6
|
|
6
6
|
Requires-Python: >=3.10
|
|
@@ -10,13 +10,13 @@ Requires-Dist: colorama ==0.4.6
|
|
|
10
10
|
Requires-Dist: copier ==9.2.0
|
|
11
11
|
Requires-Dist: docker ==6.1.2
|
|
12
12
|
Requires-Dist: ipython ==8.10.0
|
|
13
|
-
Requires-Dist: jinja2 ==3.1.
|
|
13
|
+
Requires-Dist: jinja2 ==3.1.4
|
|
14
14
|
Requires-Dist: questionary ==1.10.0
|
|
15
15
|
Requires-Dist: rich ==13.5.2
|
|
16
16
|
Requires-Dist: schema ==0.7.5
|
|
17
17
|
Requires-Dist: SQLAlchemy ==1.4.46
|
|
18
|
-
Requires-Dist: vantage6-common ==4.
|
|
19
|
-
Requires-Dist: vantage6-client ==4.
|
|
18
|
+
Requires-Dist: vantage6-common ==4.5.0rc3
|
|
19
|
+
Requires-Dist: vantage6-client ==4.5.0rc3
|
|
20
20
|
Provides-Extra: dev
|
|
21
21
|
Requires-Dist: coverage ==6.4.4 ; extra == 'dev'
|
|
22
22
|
Requires-Dist: black ; extra == 'dev'
|
|
@@ -31,12 +31,14 @@ Requires-Dist: pre-commit ; extra == 'dev'
|
|
|
31
31
|
<h3 align="center">
|
|
32
32
|
|
|
33
33
|
<!-- Badges go here-->
|
|
34
|
+
|
|
34
35
|
[](https://github.com/vantage6/vantage6/actions/workflows/release.yml)
|
|
35
36
|
[](https://badge.fury.io/py/vantage6)
|
|
36
37
|
[](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml)
|
|
37
38
|
[](https://coveralls.io/github/vantage6/vantage6?branch=main)
|
|
38
|
-
[](https://
|
|
39
|
-
[](https://app.codacy.com/gh/vantage6/vantage6/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
|
40
|
+
[](https://zenodo.org/badge/latestdoi/492818831)
|
|
41
|
+
|
|
40
42
|
</h3>
|
|
41
43
|
|
|
42
44
|
<p align="center">
|
|
@@ -46,8 +48,8 @@ Requires-Dist: pre-commit ; extra == 'dev'
|
|
|
46
48
|
<a href="#black_nib-references">References</a>
|
|
47
49
|
</p>
|
|
48
50
|
|
|
51
|
+
---
|
|
49
52
|
|
|
50
|
-
-----------------------------------------------------------------------------------------------------
|
|
51
53
|
This repository is contains all the **vantage6** infrastructure source code. The **vantage6** technology enables to manage and deploy privacy enhancing technologies like Federated Learning (FL) and Multi-Party Computation (MPC). Please visit our [website (vantage6.ai)](https://vantage6.ai) to learn more!
|
|
52
54
|
|
|
53
55
|
You can find more (user) documentation at [readthedocs (docs.vantage6.ai)](https://docs.vantage6.ai). If you have any questions, suggestions or just want to chat about federated learning: join our [Discord (https://discord.gg/yAyFf6Y)](https://discord.gg/yAyFf6Y) channel.
|
|
@@ -56,14 +58,16 @@ You can find more (user) documentation at [readthedocs (docs.vantage6.ai)](https
|
|
|
56
58
|
|
|
57
59
|
|
|
58
60
|
|
|
59
|
-
|
|
61
|
+
_A High level overview of the vantage6 infrastructure. Vantage6 has both a client-server and peer-to-peer architecture. The client is used by the researcher to create (PET) computation requests. It is also used to manage users, organizations and collaborations. The server contains users, organizations, collaborations, tasks and their results. It provides a central access point for both the clients and nodes. The nodes have access to privacy sensitive data and handle computation requests retrieved from the server. Computation request are executed as separate containers on the node. These containers are connected to containers at other nodes by a VPN network._
|
|
60
62
|
|
|
61
63
|
## :books: Quickstart
|
|
62
64
|
|
|
63
65
|
### Requirements
|
|
66
|
+
|
|
64
67
|
The **vantage6** infrastructure is delivered in Docker images. To run these images, you need to have [Docker](https://docs.docker.com/get-docker/) installed. To install the latest version of the vantage6 CLI, you need to have [Python](https://www.python.org/downloads/), we recommend using an environment manager like [mini-conda](https://docs.conda.io/en/latest/miniconda.html).
|
|
65
68
|
|
|
66
69
|
Install the latest version of the vantage6 CLI by using:
|
|
70
|
+
|
|
67
71
|
```bash
|
|
68
72
|
pip install vantage6
|
|
69
73
|
```
|
|
@@ -98,8 +102,8 @@ v6 server attach
|
|
|
98
102
|
|
|
99
103
|
From here you can use the [vantage6-client](https://pypi.org/project/vantage6-client) to interact with the server. The demo network has a pre-configured organization with the following credentials:
|
|
100
104
|
|
|
101
|
-
|
|
102
|
-
|
|
105
|
+
- Username: `org_1-admin`
|
|
106
|
+
- Password: `password`
|
|
103
107
|
|
|
104
108
|
For example, you can create a new organization by running:
|
|
105
109
|
|
|
@@ -125,16 +129,17 @@ You can find more (user) documentation at [readthedocs (docs.vantage6.ai)](https
|
|
|
125
129
|
## Project structure
|
|
126
130
|
|
|
127
131
|
### PYPI packages
|
|
132
|
+
|
|
128
133
|
This repository is home to 6 PyPi packages:
|
|
129
134
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
135
|
+
- [vantage6](https://pypi.org/project/vantage6) -> _CLI for managing node and server instances_
|
|
136
|
+
- [vantage6-client](https://pypi.org/project/vantage6-client) -> _Python client for interacting with the vantage6-server_
|
|
137
|
+
- [vantage6-algorithm-tools](https://pypi.org/project/vantage6-algorithm-tools) -> _Python tools to facilitate algorithm development_
|
|
138
|
+
- [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
|
|
139
|
+
- [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_
|
|
140
|
+
- [vantage6-algorithm-store](https://pypi.org/project/vantage6-algorithm-store) -> _Algorithm store application package_
|
|
141
|
+
- [vantage6-common](https://pypi.org/project/vantage6-common) -> _Package with common vantage6 functions_
|
|
142
|
+
- [vantage6-backend-common](https://pypi.org/project/vantage6-backend-common) -> _Package with functions common to central server and algorithm store_
|
|
138
143
|
|
|
139
144
|
**Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**
|
|
140
145
|
|
|
@@ -143,30 +148,32 @@ is an Angular web application that can be used to interact with the vantage6 ser
|
|
|
143
148
|
easily.
|
|
144
149
|
|
|
145
150
|
### Docker images
|
|
151
|
+
|
|
146
152
|
The vantage6 infrastructure is delivered in Docker images. All Docker images are stored in our private [Harbor](https://goharbor.io/) registry. The most important images are:
|
|
147
153
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
154
|
+
- `harbor2.vantage6.ai/infrastructure/node:VERSION` -> _Node application Docker image_
|
|
155
|
+
- `harbor2.vantage6.ai/infrastructure/server:VERSION` -> _Server application Docker image_
|
|
156
|
+
- `harbor2.vantage6.ai/infrastructure/ui:VERSION` -> _User interface Docker image_
|
|
157
|
+
- `harbor2.vantage6.ai/infrastructure/algorithm-store:VERSION` -> _Algorithm store Docker image_
|
|
152
158
|
|
|
153
159
|
with `VERSION` being the full semantic version of the vantage6 infrastructure, e.g. `4.0.0` or `4.1.0rc0`.
|
|
154
160
|
|
|
155
161
|
Several other images are used to support the infrastructure:
|
|
156
162
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
+
- `harbor2.vantage6.ai/infrastructure/infrastructure-base:VERSION` -> _Base image for the infrastructure_
|
|
164
|
+
- `harbor2.vantage6.ai/infrastructure/squid:VERSION` -> _Squid proxy image used for the whitelisting service_
|
|
165
|
+
- `harbor2.vantage6.ai/infrastructure/alpine` -> _Alpine image used for vpn traffic forwarding_
|
|
166
|
+
- `harbor2.vantage6.ai/infrastructure/vpn-client` -> _VPN image used to connect to the VPN_
|
|
167
|
+
- `harbor2.vantage6.ai/infrastructure/vpn-configurator` -> _VPN image used for initialization_
|
|
168
|
+
- `harbor2.vantage6.ai/infrastructure/ssh-tunnel` -> _SSH tunnel image used for connecting algorithms to external services_
|
|
163
169
|
|
|
164
170
|
And finally there are some images released for algorithm development:
|
|
165
171
|
|
|
166
|
-
|
|
167
|
-
|
|
172
|
+
- `harbor2.vantage6.ai/infrastructure/algorithm-base:MAJOR.MINOR` -> _Base image for algorithm development_
|
|
173
|
+
- `harbor2.vantage6.ai/infrastructure/algorithm-ohdsi-base:MAJOR.MINOR` -> _Extended algorithm base image for OHDSI algorithm development_
|
|
168
174
|
|
|
169
175
|
## :gift_heart: Join the community!
|
|
176
|
+
|
|
170
177
|
We hope to continue developing, improving, and supporting **vantage6** with the help of the federated learning community. If you are interested in contributing, first of all, thank you! Second, please take a look at our [contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html)
|
|
171
178
|
|
|
172
179
|
<a href="https://github.com/vantage6/vantage6/graphs/contributors">
|
|
@@ -174,13 +181,15 @@ We hope to continue developing, improving, and supporting **vantage6** with the
|
|
|
174
181
|
</a>
|
|
175
182
|
|
|
176
183
|
## :black_nib: References
|
|
184
|
+
|
|
177
185
|
If you are using **vantage6**, please cite this repository as well as the accompanying papers as follows:
|
|
178
186
|
|
|
179
|
-
>
|
|
180
|
-
>
|
|
181
|
-
>
|
|
187
|
+
> - F. Martin, M. Sieswerda, H. Alradhi, et al. vantage6. Available at https://doi.org/10.5281/zenodo.7221216. Accessed on MONTH, 20XX.
|
|
188
|
+
> - A. Moncada-Torres, F. Martin, M. Sieswerda, J. van Soest, G. Gelijnse. VANTAGE6: an open source priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange. AMIA Annual Symposium Proceedings, 2020, p. 870-877. [[BibTeX](https://arturomoncadatorres.com/bibtex/moncada-torres2020vantage6.txt), [PDF](https://vantage6.ai/vantage6/)]
|
|
189
|
+
> - D. Smits\*, B. van Beusekom\*, F. Martin, L. Veen, G. Geleijnse, A. Moncada-Torres, An Improved Infrastructure for Privacy-Preserving Analysis of Patient Data, Proceedings of the International Conference of Informatics, Management, and Technology in Healthcare (ICIMTH), vol. 25, 2022, p. 144-147. [[BibTeX](https://arturomoncadatorres.com/bibtex/smits2022improved.txt), [PDF](https://ebooks.iospress.nl/volumearticle/60190)]
|
|
190
|
+
|
|
191
|
+
---
|
|
182
192
|
|
|
183
|
-
-----------------------------------------------------------------------------------------------------
|
|
184
193
|
<p align="center">
|
|
185
194
|
<a href="https://vantage6.ai">vantage6.ai</a> •
|
|
186
195
|
<a href="https://discord.gg/yAyFf6Y">Discord</a> •
|
|
@@ -4,8 +4,8 @@ tests_cli/test_node_cli.py,sha256=izMUo9r5GjIvXnDjPtaQTQtd9mbb14Z1HFTgobxLmk4,15
|
|
|
4
4
|
tests_cli/test_server_cli.py,sha256=nilQYLV4GuKdNaYRaMO5y13h6P3mw8Dvvf8H84RS43I,5857
|
|
5
5
|
tests_cli/test_wizard.py,sha256=NPl3Kp6_Et0GatLfD-p5LagMbkFwEx-vHiOgKoVvxDM,4385
|
|
6
6
|
vantage6/cli/__build__,sha256=TgdAhWK-24tgzgXB3s_jrRa3IjCWfeAfZAt-Rym0n84,1
|
|
7
|
-
vantage6/cli/__init__.py,sha256
|
|
8
|
-
vantage6/cli/_version.py,sha256=
|
|
7
|
+
vantage6/cli/__init__.py,sha256=-Ec-Z7ELDveGdSALXda3qdUGpkuKyJQfhN3eIm7koHE,127
|
|
8
|
+
vantage6/cli/_version.py,sha256=MUALYeqOCppxhBOwzbIP5lcsqpfKOa62OiMDGqpyZVM,700
|
|
9
9
|
vantage6/cli/cli.py,sha256=b5Gvhn4PL4UWShAJB5lHOf37Q_VRUw3UMNgDECZuHHM,5945
|
|
10
10
|
vantage6/cli/configuration_manager.py,sha256=cN4tQpQjLG5GaGrsjEP-5ed_LqvPApIkNkM1J6ai3n0,3588
|
|
11
11
|
vantage6/cli/configuration_wizard.py,sha256=9dfAnBWsvxEEm2HX1_lUURSbSvFoc6d8YkoUYXKDqcI,17949
|
|
@@ -64,8 +64,8 @@ vantage6/cli/template/server_import_config.j2,sha256=PRB0ym_FYjx9vhkmY9C0xzlv_85
|
|
|
64
64
|
vantage6/cli/test/feature_tester.py,sha256=vTmJrqjA6J_GFWvZDmin4Nx1AO2Mhy21YacTr2vZi2U,2497
|
|
65
65
|
vantage6/cli/test/integration_test.py,sha256=DT3qjl1lq7nVBflT5ed1Yu2aNT1cwHCqh8_hafi4e2k,3802
|
|
66
66
|
vantage6/cli/test/common/diagnostic_runner.py,sha256=x_4ikihgoSTKI914pqlgVziBSg5LpV6MheO6O_GBCeA,6657
|
|
67
|
-
vantage6-4.
|
|
68
|
-
vantage6-4.
|
|
69
|
-
vantage6-4.
|
|
70
|
-
vantage6-4.
|
|
71
|
-
vantage6-4.
|
|
67
|
+
vantage6-4.5.0rc3.dist-info/METADATA,sha256=PhgJSUnrpQe4fbF-Z0PYzRyTWNg0CW08iyJQRSRR32M,10227
|
|
68
|
+
vantage6-4.5.0rc3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
69
|
+
vantage6-4.5.0rc3.dist-info/entry_points.txt,sha256=YFBvwjxoeAGxYyPC-YevEgOBBYRGaXkS6jiOGGCLNy0,157
|
|
70
|
+
vantage6-4.5.0rc3.dist-info/top_level.txt,sha256=CYDIBS8jEfFq5YCs_Fuit54K9-3wdosZppTrsymIoUk,19
|
|
71
|
+
vantage6-4.5.0rc3.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|