Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure framework explainers #2235

Merged
merged 19 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@
"logging": "how-to-configure-logging.html",
"ssl-enabled-connections": "how-to-enable-ssl-connections.html",
"upgrade-to-flower-1.0": "how-to-upgrade-to-flower-1.0.html",

# Restructuring: explanations
"evaluation": "explanation-federated-evaluation.html",
"differential-privacy-wrappers": "explanation-differential-privacy.html",

# Deleted pages
"people": "index.html",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Differential Privacy Wrappers in Flower
=======================================
Differential privacy
====================

Flower provides differential privacy (DP) wrapper classes for the easy integration of the central DP guarantees provided by DP-FedAvg into training pipelines defined in any of the various ML frameworks that Flower is compatible with.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Evaluation
==========
Federated evaluation
====================

There are two main approaches to evaluating models in federated learning systems: centralized (or server-side) evaluation and federated (or client-side) evaluation.


Centralized Evaluation
----------------------

Expand Down Expand Up @@ -171,6 +172,7 @@ Model parameters can also be evaluated during training. :code:`Client.fit` can r
def evaluate(self, parameters, config):
# ...


Full Code Example
-----------------

Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ Understanding-oriented concept guides explain and discuss key topics and underly
:maxdepth: 1
:caption: Explanations

evaluation
differential-privacy-wrappers
explanation-federated-evaluation
explanation-differential-privacy

References
~~~~~~~~~~
Expand Down