From 202bf02cd703a0ffaf957ae74eabf910a10b10ed Mon Sep 17 00:00:00 2001 From: kta-intel Date: Fri, 5 Jan 2024 14:18:54 -0800 Subject: [PATCH] indexing federated evaluation page under manual Signed-off-by: kta-intel --- docs/federated_evaluation.rst | 5 ++--- docs/manual.rst | 1 + 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/federated_evaluation.rst b/docs/federated_evaluation.rst index 4f2d6e32dc..b38687d269 100644 --- a/docs/federated_evaluation.rst +++ b/docs/federated_evaluation.rst @@ -1,6 +1,5 @@ - Federated Evaluation with OpenFL -============================== +================================= Introduction to Federated Evaluation ------------------------------------- @@ -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 `_. 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``. diff --git a/docs/manual.rst b/docs/manual.rst index cdab47482a..a0a7254c76 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -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