Skip to content

Commit

Permalink
indexing federated evaluation page under manual
Browse files Browse the repository at this point in the history
Signed-off-by: kta-intel <[email protected]>
  • Loading branch information
kta-intel committed Jan 5, 2024
1 parent c4b5ef4 commit 202bf02
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/federated_evaluation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

Federated Evaluation with OpenFL
==============================
=================================

Introduction to Federated Evaluation
-------------------------------------
Expand All @@ -20,7 +19,7 @@ In general pipeline is as follows:
4. **Aggregation**: The aggregator collects and aggregates these metrics to assess overall model performance.

Example Using the Task Runner API (Aggregator-based Workflow)
----------------------------------------------
-------------------------------------------------------------------

To demonstrate usage of the task runner API (aggregator-based workflow) for federated evaluation, consider the `Hello Federation example <https://github.com/securefederatedai/openfl/blob/develop/tests/github/test_hello_federation.py>`_. This sample script creates a simple federation with two collaborator nodes and one aggregator node, and executes based on a user specified workspace template. We provide a ``torch_cnn_mnist_fed_eval`` template, which is a federated evaluation template adapted from ``torch_cnn_mnist``.

Expand Down
1 change: 1 addition & 0 deletions docs/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Explore new and experimental features:
install
running_the_federation
running_the_federation_with_gandlf
federated_evaluation
source/utilities/utilities
advanced_topics
source/workflow/running_the_federation.tutorial
Expand Down

0 comments on commit 202bf02

Please sign in to comment.