This repository has been archived by the owner on Aug 29, 2023. It is now read-only.
forked from ldsec/drynx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes: #5
- Loading branch information
Showing
1 changed file
with
18 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,21 @@ | ||
| [](https://travis-ci.org/ldsec/drynx) [](https://goreportcard.com/report/github.com/ldsec/drynx) [](https://coveralls.io/github/ldsec/drynx?branch=master) | ||
| # Drynx | ||
| Drynx is a library for simulating a privacy-preserving and verifiable data sharing/querying tool. It offers a series of independent protocols that when combined offer a verifiably-secure and safe way to compute statistics and train basic machine learning models on distributed sensitive data (e.g., medical data). | ||
|
|
||
| The paper has all the details: [Drynx: Decentralized, Secure, Verifiable System for Statistical Queries and Machine Learning on Distributed Datasets](https://arxiv.org/abs/1902.03785) | ||
|
|
||
| Drynx is developed by LDS (Laboratory for Data Security in EPFL) in collaboration with DeDiS (Laboratory for Decentralized and Distributed Systems). It is build on the [UnLynx library](https://github.com/ldsec/unlynx) and does an intensive use of [Overlay-network (ONet) library](https://go.dedis.ch/onet/v3) and of the [Advanced Crypto (kyber) library](https://go.dedis.ch/kyber/v3). | ||
|
|
||
| ## Documentation | ||
|
|
||
| * For more information regarding the underlying architecture please refer to the stable version of ONet `go.dedis.ch/onet/v3` | ||
| * To check the code organisation, have a look at [Layout](https://github.com/ldsec/drynx/wiki/Layout) | ||
| * For more information on how to run our protocols, services, simulations and apps, go to [Running Drynx](https://github.com/ldsec/drynx/wiki/Running-Drynx) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To use the code of this repository you need to: | ||
| [](https://travis-ci.org/c4dt/drynx) | ||
| [](https://goreportcard.com/report/github.com/c4dt/drynx) | ||
| [](https://coveralls.io/github/c4dt/drynx?branch=master) | ||
|
|
||
| - Install [Golang](https://golang.org/doc/install) | ||
| - [Recommended] Install [IntelliJ IDEA](https://www.jetbrains.com/idea/) and the GO plugin | ||
| - Set [`$GOPATH`](https://golang.org/doc/code.html#GOPATH) to point to your workspace directory | ||
| - Add `$GOPATH/bin` to `$PATH` | ||
| - Git clone this repository to $GOPATH/src `git clone https://github.com/ldsec/drynx.git` or... | ||
| - go get repository: `go get github.com/ldsec/drynx` | ||
|
|
||
| ## Version | ||
|
|
||
| We only have a development version. The `master`-branch in `github.com/ldsec/drynx` is the development version that works but can have incompatible changes. | ||
|
|
||
| ## License | ||
|
|
||
| Drynx is licensed under a End User Software License Agreement ('EULA') for non-commercial use. If you need more information, please contact us. | ||
|
|
||
| ## Contact | ||
| You can contact any of the developers for more information or any other member of [lds](https://search.epfl.ch/?filter=unit&q=lds): | ||
| # Drynx | ||
|
|
||
| * [David Froelicher](https://github.com/froelich) (PHD student) - [email protected] | ||
| * [Joao Andre Sa](https://github.com/JoaoAndreSa) (Software Engineer) - [email protected] | ||
| Drynx is a library for simulating a privacy-preserving and verifiable data sharing/querying tool. It offers a series of independent protocols that when combined offer a verifiably-secure and safe way to compute statistics and train basic machine learning models on distributed sensitive data (e.g., medical data). | ||
|
|
||
| This is a [fork of LDS drynx](https://github.com/ldsec/drynx), this is what is officially running at [C4DT](https://c4dt.org). It has some stabilising features that are being merged upstream: | ||
|
|
||
| * datasets loaders, found in `lib/provider/loaders` | ||
| * one keeping the upstream behavior of randomly generating data | ||
| * one file based, reading CSV values and populating the Data Provider with it | ||
| * CLI interface, found in `cmd` | ||
| * `server` to run a Drynx node | ||
| * `client` to communicate from the command line with the nodes | ||
| * some others changes | ||
| * allow to select which column to query | ||
| * splits of some structures to allow for dedis/protobuf auto-generation | ||
| * docker image for the server | ||
| * some revamp of operation to more modularise them |