Add comments to plan.yaml

securefederatedai · Nov 27, 2023 · 5cfe878 · 5cfe878
1 parent 69dddf6
commit 5cfe878
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/openfl-workspace/torch_cnn_mnist_fed_eval/plan/plan.yaml b/openfl-workspace/torch_cnn_mnist_fed_eval/plan/plan.yaml
@@ -8,7 +8,9 @@ aggregator :
     init_state_path     : save/torch_cnn_mnist_init.pbuf
     best_state_path     : save/torch_cnn_mnist_best.pbuf
     last_state_path     : save/torch_cnn_mnist_last.pbuf
+    ######### SET ROUNDS TO 1 #############
     rounds_to_train     : 1
+    #######################################
     log_metric_callback :
       template : src.mnist_utils.write_metric
 
@@ -35,21 +37,25 @@ network :
   defaults : plan/defaults/network.yaml
 
 assigner :
+  ######### SET ASSIGNER TO ONLY INCLUDE AGGREGATED MODEL VALIDATION #############
   template : openfl.component.RandomGroupedAssigner
   settings :
     task_groups  :
       - name       : validate
         percentage : 1.0
         tasks      :
           - aggregated_model_validation
+  ################################################################################
 
 tasks :
+  ######### SET AGGREGATED MODEL VALIDATION AS ONLY TASK #############
   aggregated_model_validation:
     function : validate
     kwargs   :
       apply   : global
       metrics :
         - acc
+  ####################################################################
 
 compression_pipeline :
-  defaults : plan/defaults/compression_pipeline.yaml
+  defaults : plan/defaults/compression_pipeline.yaml