Skip to content

Commit 5b5ead7

Browse files
committed
fix docs
1 parent 37ae1f9 commit 5b5ead7

172 files changed

Lines changed: 23552 additions & 50848 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

MEDfl/rw/client.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,35 @@ def __init__(
4747

4848

4949
class FlowerClient(fl.client.NumPyClient):
50+
"""
51+
Federated learning client for MEDfl real-world pipelines.
52+
53+
This client:
54+
- connects to a Flower server,
55+
- loads local CSV data,
56+
- applies server-provided schema (features/target),
57+
- handles train/val/test splits (fractions or test_ids),
58+
- optionally enables differential privacy with Opacus.
59+
60+
Parameters
61+
----------
62+
server_address : str
63+
Address of the Flower server, e.g. ``"127.0.0.1:8080"``.
64+
data_path : str, optional
65+
Path to the local CSV file. Default is ``"data/data.csv"``.
66+
dp_config : DPConfig, optional
67+
Differential privacy configuration. If ``None``, DP is disabled.
68+
val_frac : float, optional
69+
Client-side validation fraction override. If ``None``, use server value.
70+
test_frac : float, optional
71+
Client-side test fraction override. If ``None``, use server value.
72+
id_col : str, optional
73+
Name of the ID column used when selecting test samples via ``test_ids``.
74+
test_ids : str, optional
75+
Comma-separated list of IDs (or line numbers) to use as test set.
76+
seed : int, optional
77+
Random seed used for splits. Default is ``42``.
78+
"""
5079
def __init__(
5180
self,
5281
server_address,

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
88
SOURCEDIR = source
9-
BUILDDIR = build
9+
BUILDDIR = _build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:
-373 KB
Binary file not shown.
-191 KB
Binary file not shown.
-969 KB
Binary file not shown.
-4.96 KB
Binary file not shown.

docs/_build/_modules/Medfl/NetManager/network.html

Lines changed: 0 additions & 303 deletions
This file was deleted.

docs/_build/_sources/index.rst.txt

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/_build/_sources/modules.rst.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/_build/_static/MEDomics.png

-125 KB
Binary file not shown.

0 commit comments

Comments
 (0)