Skip to content

Commit b2a55af

Browse files
committed
Add some draft doc.
1 parent 609b79a commit b2a55af

4 files changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# VertiBench: Vertical Federated Learning Benchmark
2+
3+
## Introduction
4+
5+
VertiBench is a benchmark for [federated learning](https://ieeexplore.ieee.org/abstract/document/9599369/), [split learning](https://arxiv.org/abs/1912.12115), and [assisted learning](https://proceedings.neurips.cc/paper_files/paper/2022/hash/4d6938f94ab47d32128c239a4bfedae0-Abstract-Conference.html) on vertical partitioned data. It provides tools to synthetic vertical partitioned data from a given global dataset. VertiBench supports partition under various **imbalance** and **correlation** level, effectively simulating a wide-range of real-world vertical federated learning scenarios.
6+
7+
8+
![data-dist-full.png](fig%2Fdata-dist-full.png)
9+
10+
## Installation
11+
12+
VertiBench has already been published on PyPI. The installation requires the installation of `python>=3.9`. To further install VertiBench, run the following command:
13+
14+
```bash
15+
pip install vertibench
16+
```
17+
18+
## Getting Started
19+

example/EvaluatorExample.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
from sklearn.datasets import make_classification
2+
3+
# Generate a large dataset
4+
X, y = make_classification(n_samples=10000, n_features=10)
5+
6+
7+
from vertibench import Evaluator
8+
9+
evaluator = Evaluator.ImportanceEvaluator(sample_rate=0.1)

example/SplitExample.py

Whitespace-only changes.

fig/data-dist-full.png

461 KB
Loading

0 commit comments

Comments
 (0)