Skip to content

Commit 2692150

Browse files
authored
Update federated evaluation documentation (#1624)
* Update federated evaluation documentation and adjust input shape for Keras data loader. Removed input shape specification from the plan.yaml file and updated the feature shape in the KerasHippmapp3rsynth class to [160, 160, 128]. Additionally, modified the README to reflect changes in the plan initialization command by removing the input shape argument. Signed-off-by: Rahul Garg <rahul.garg@intel.com> * Update taskrunner tutorial to clarify the command's support for model initializations. Adjusted wording to enhance understanding of the FL experiment plan setup process. Signed-off-by: Rahul Garg <rahul.garg@intel.com> --------- Signed-off-by: Rahul Garg <rahul.garg@intel.com>
1 parent 910f13c commit 2692150

File tree

5 files changed

+3
-11
lines changed

5 files changed

+3
-11
lines changed

docs/about/features_index/fed_eval.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,6 @@ The plan initialize command supports the optional `--init_model_path` (shortform
108108
-c, --cols_config PATH Path to an authorized collaborator list. [default: plan/cols.yaml]
109109
-d, --data_config PATH The dataset shard configuration file. [default: plan/data.yaml]
110110
-a, --aggregator_address TEXT The FQDN of the federation aggregator
111-
-f, --input_shape TEXT The input spec of the model.
112-
113-
May be provided as a list for single input head: ``--input-shape [3,32,32]``,
114-
115-
or as a dictionary for multihead models (must be passed in quotes):
116-
117-
``--input-shape "{'input_0': [1, 240, 240, 4],'input_1': [1, 240, 240, 1]}"``.
118111
-g, --gandlf_config TEXT GaNDLF Configuration File Path
119112
-r, --install_reqs BOOLEAN If set, installs packages listed under 'requirements.txt'. [default: True]
120113
-i, --init_model_path PATH Path to initial model protobuf file.

docs/tutorials/taskrunner.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
"### Initialize a Plan\n",
7070
"\n",
7171
"This step builds an entire FL experiment plan, along with the initial set of parameters that will be used in the experiment.\n",
72-
"We supply `localhost` as the aggregator address, for simulation purposes. The command below supports models of arbitrary input shapes and initializations (e.g. when using pre-trained models).\n",
72+
"We supply `localhost` as the aggregator address, for simulation purposes. The command below supports models initializations (e.g. when using pre-trained models).\n",
7373
"\n",
7474
"For a complete list of supported options, refer to [`fx plan initialize`](https://openfl.readthedocs.io/en/latest/reference/fx.plan.html#fx-plan-initialize)."
7575
]

openfl-workspace/keras/hippmapp3r/plan/plan.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ data_loader :
2222
template : src.dataloader.KerasHippmapp3rsynth
2323
settings :
2424
batch_size : 1
25-
input_shape : [160, 160, 128]
2625

2726
task_runner :
2827
defaults : plan/defaults/task_runner.yaml

openfl-workspace/keras/hippmapp3r/src/dataloader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def __init__(self, data_path=None, batch_size=32, **kwargs):
2424
**kwargs: Additional arguments, passed to super init and load_mnist_shard
2525
"""
2626
super().__init__(batch_size, **kwargs)
27-
self.feature_shape = [64, 64, 128] # Hippmapp3r shape for Keras (channels last)
27+
self.feature_shape = [160, 160, 128] # Hippmapp3r shape for Keras (channels last)
2828

2929
# If data_path is None, this is being used for model initialization only
3030
if data_path is None:

openfl-workspace/torch/mnist/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ To help OpenFL calculate the initial model weights, we need to provide the shape
168168

169169
```
170170
mkdir save
171-
fx plan initialize --input_shape [1,28,28] --aggregator_address localhost
171+
fx plan initialize --aggregator_address localhost
172172
```
173173

174174
We can now perform a test run with the following commands for creating a local PKI setup and starting the aggregator and the collaborators on the same machine:

0 commit comments

Comments
 (0)