Resolve Visibility of Aggregator Private Attributes in Experimental Workflow

[refai06]

Background

This PR solves the (Experimental Workflow Interface) Aggregator private attributes visible to Collaborators #1052

Change Description

1. Created clones of the FLSpec object before starting flow execution in Aggregator to ensure that FLSpec object does not contain private attribues
2. Removed the clone creation functionality from the next method of the FLSpec class
3. Updated Aggregator do_task method to handle the filter_exclude_include functionality during the aggregator to collaborator transition.
4. Removed the filter_exclude_include functionality from the next method of the FLSpec class

Modifications

openfl/experimental/component/aggregator/aggregator.py
openfl/experimental/interface/fl_spec.py
tests/github/experimental/workspace/testcase_private_attributes/src/aggregator_private_attrs.py
tests/github/experimental/workspace/testcase_private_attributes/src/testflow_privateattributes.py
tests/github/experimental/workspace/testcase_private_attributes_initialization_with_both_options/src/aggregator_private_attrs.py
tests/github/experimental/workspace/testcase_private_attributes_initialization_with_both_options/src/testflow_privateattributes.py
tests/github/experimental/workspace/testcase_private_attributes_initialization_without_callable/src/aggregator_private_attrs.py
tests/github/experimental/workspace/testcase_private_attributes_initialization_without_callable/src/testflow_privateattributes.py

Verification

Verified all testcases from tests/github/experimental/workspace

-tests/github/experimental/workspace/testcase_datastore_cli

-tests/github/experimental/workspace/testcase_include_exclude

-tests/github/experimental/workspace/testcase_private_attributes

-tests/github/experimental/workspace/testcase_private_attributes_initialization_with_both_options

-tests/github/experimental/workspace/testcase_private_attributes_initialization_without_callable

-tests/github/experimental/workspace/testcase_internalloop

-tests/github/experimental/workspace/testcase_reference

-tests/github/experimental/workspace/testcase_reference_with_include_exclude

-tests/github/experimental/workspace/testcase_subset_of_collaborators

Tutorials

Openfl-workspace/experimental/

-101_torch_cnn_mnist

-301_torch_cnn_mnist_watermarking

[teoparvanov]

If we remove the private attribute filtering from here, then who is responsible for doing it, especially if we execute the FLSpec via the run() method, rather than through the export feature?

[refai06]

Private attribute filtering is required while transitioning from aggregator to collab (and vice-versa). For LocalRuntime it is done inside Participants (openfl/experimental/interface/participants.py) and in FederatedRuntime it is done inside Component (openfl/experimental/component/aggregator/aggregator.py and openfl/experimental/component/collaborator/collaborator.py)

[teoparvanov]

I see, thanks for the explanation, @refai06 - the distinction is indeed not obvious for the "uninitiated" reader...

As a follow-up PR, I'd suggest re-organizing a little bit the code, to make it easier to navigate and review. Right now, everything related to Workflow API resides directly under openfl/experimental - thus implicitly "disallowing" other experimental features. Instead, it may be better to have a dedicated openfl/experimental/workflow package for example. Additionally, under openfl/experimental/workflow, we could imagine separate sub-packages for local, federated and export for example.

WDYT?

[teoparvanov]

A general question regarding test coverage - do the test cases under tests/github/experimental/workspace cover both "runtimes":

• the local runtime Aggregator and Collaborator classes in participants.py
• the federated runtime Aggregator and Collaborator classes from experimental.component

?

[refai06]

@teoparvanov :
The test cases under tests/github/experimental/workspace cover only Aggregator Based Workflow. For test cases related to the LocalRuntime, please refer to the testcase in openfl/tests/github/experimental