From 7f16cdb77bd3a7fd1b9b38daf8791fde9f316ebf Mon Sep 17 00:00:00 2001 From: Ishant Thakare Date: Fri, 20 Dec 2024 14:55:41 +0530 Subject: [PATCH] Resolving merge conflicts Signed-off-by: Ishant Thakare --- docs/source/api/openfl_component.rst | 19 ------------------- docs/source/api/openfl_cryptography.rst | 16 ---------------- docs/source/api/openfl_databases.rst | 16 ---------------- docs/source/api/openfl_experimental.rst | 18 ------------------ docs/source/api/openfl_federated.rst | 18 ------------------ docs/source/api/openfl_interface.rst | 16 ---------------- docs/source/api/openfl_native.rst | 16 ---------------- docs/source/api/openfl_pipelines.rst | 16 ---------------- docs/source/api/openfl_plugins.rst | 16 ---------------- docs/source/api/openfl_protocols.rst | 16 ---------------- docs/source/api/openfl_transport.rst | 15 --------------- docs/source/api/openfl_utilities.rst | 16 ---------------- docs/source/openfl/director_workflow.svg | 1 - docs/source/openfl/static_diagram.svg | 1 - 14 files changed, 200 deletions(-) delete mode 100644 docs/source/api/openfl_component.rst delete mode 100644 docs/source/api/openfl_cryptography.rst delete mode 100644 docs/source/api/openfl_databases.rst delete mode 100644 docs/source/api/openfl_experimental.rst delete mode 100644 docs/source/api/openfl_federated.rst delete mode 100644 docs/source/api/openfl_interface.rst delete mode 100644 docs/source/api/openfl_native.rst delete mode 100644 docs/source/api/openfl_pipelines.rst delete mode 100644 docs/source/api/openfl_plugins.rst delete mode 100644 docs/source/api/openfl_protocols.rst delete mode 100644 docs/source/api/openfl_transport.rst delete mode 100644 docs/source/api/openfl_utilities.rst delete mode 100644 docs/source/openfl/director_workflow.svg delete mode 100644 docs/source/openfl/static_diagram.svg diff --git a/docs/source/api/openfl_component.rst b/docs/source/api/openfl_component.rst deleted file mode 100644 index 0af3099b49..0000000000 --- a/docs/source/api/openfl_component.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Component Module -************************************************* - -Component modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.component.aggregator - openfl.component.assigner - openfl.component.collaborator - openfl.component.director - openfl.component.envoy diff --git a/docs/source/api/openfl_cryptography.rst b/docs/source/api/openfl_cryptography.rst deleted file mode 100644 index 475ebd1e9b..0000000000 --- a/docs/source/api/openfl_cryptography.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Cryptography Module -************************************************* - -Cryptography modules reference: - -.. autosummary:: - :toctree: _autosummary - :recursive: - - openfl.cryptography.ca - openfl.cryptography.io - openfl.cryptography.participant diff --git a/docs/source/api/openfl_databases.rst b/docs/source/api/openfl_databases.rst deleted file mode 100644 index 8014d42114..0000000000 --- a/docs/source/api/openfl_databases.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Databases Module -************************************************* - -Databases modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.databases - \ No newline at end of file diff --git a/docs/source/api/openfl_experimental.rst b/docs/source/api/openfl_experimental.rst deleted file mode 100644 index 907645686d..0000000000 --- a/docs/source/api/openfl_experimental.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Experimental Module -************************************************* - -Experimental modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.experimental.workflow.interface - openfl.experimental.workflow.placement - openfl.experimental.workflow.runtime - openfl.experimental.workflow.utilities diff --git a/docs/source/api/openfl_federated.rst b/docs/source/api/openfl_federated.rst deleted file mode 100644 index 8c3d50b81e..0000000000 --- a/docs/source/api/openfl_federated.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Federated Module -************************************************* - -Federated modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.federated.plan - openfl.federated.task - openfl.federated.data - \ No newline at end of file diff --git a/docs/source/api/openfl_interface.rst b/docs/source/api/openfl_interface.rst deleted file mode 100644 index 8685cce5f0..0000000000 --- a/docs/source/api/openfl_interface.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Interface Module -************************************************* - -Interface modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.interface - \ No newline at end of file diff --git a/docs/source/api/openfl_native.rst b/docs/source/api/openfl_native.rst deleted file mode 100644 index 5f3f513340..0000000000 --- a/docs/source/api/openfl_native.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Native Module (Deprecated) -************************************************* - -Native modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.native - \ No newline at end of file diff --git a/docs/source/api/openfl_pipelines.rst b/docs/source/api/openfl_pipelines.rst deleted file mode 100644 index 42ec1b33ad..0000000000 --- a/docs/source/api/openfl_pipelines.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Pipelines Module -************************************************* - -Pipelines modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.pipelines - \ No newline at end of file diff --git a/docs/source/api/openfl_plugins.rst b/docs/source/api/openfl_plugins.rst deleted file mode 100644 index de8df91f4f..0000000000 --- a/docs/source/api/openfl_plugins.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Plugins Module -************************************************* - -Plugins modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.plugins - \ No newline at end of file diff --git a/docs/source/api/openfl_protocols.rst b/docs/source/api/openfl_protocols.rst deleted file mode 100644 index e6e571ccc3..0000000000 --- a/docs/source/api/openfl_protocols.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Protocols Module -************************************************* - -Protocols modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.protocols - \ No newline at end of file diff --git a/docs/source/api/openfl_transport.rst b/docs/source/api/openfl_transport.rst deleted file mode 100644 index 19eb01d839..0000000000 --- a/docs/source/api/openfl_transport.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Transport Module -************************************************* - -Transport modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.transport diff --git a/docs/source/api/openfl_utilities.rst b/docs/source/api/openfl_utilities.rst deleted file mode 100644 index b44e1f74d7..0000000000 --- a/docs/source/api/openfl_utilities.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -************************************************* -Utilities Module -************************************************* - -Utilities modules reference: - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - openfl.utilities - \ No newline at end of file diff --git a/docs/source/openfl/director_workflow.svg b/docs/source/openfl/director_workflow.svg deleted file mode 100644 index bdc57e11d0..0000000000 --- a/docs/source/openfl/director_workflow.svg +++ /dev/null @@ -1 +0,0 @@ -OpenFLPython API componentExperiment ManagerDirector ManagerCollaborator ManagerCentral nodeDirectorCollaborator nodeEnvoyAggregatorCollaboratorProvides FL plans, Tasks, Models, Data LoadersLaunches.Sets up global Federation settingsLaunches.Provides local dataset Shard DescriptorsCreates an instance to maintain an FL experimentCreates an instance to maintain an FL experimentCommunicates dataset info, Sends status updatesApproves, Sends FL experimentsSends locally tuned tensors and training metricsSends tasks and initial tensorsRegisters FL experimentsSends info about the Federation. Returns training artifacts \ No newline at end of file diff --git a/docs/source/openfl/static_diagram.svg b/docs/source/openfl/static_diagram.svg deleted file mode 100644 index 8f816d4e88..0000000000 --- a/docs/source/openfl/static_diagram.svg +++ /dev/null @@ -1 +0,0 @@ -Friday, 27 August 2021, 16:25 Moscow Standard TimeContainer diagram for OpenFLOpenFL[Software System]Central node-Collaborator node-Data scientist[Person]A person or group of peopleusing OpenFLEnvoy[Container]A long-living entity that can adapt alocal data set and spawncollaborators+Collaborator manager[Person]Data owner's representativecontrolling EnvoyDirector manager[Person]-Collaborator[Container]Actor executing tasks on local datainside one experiment+Python API component[Container]A set of tools to setup register FLExperiments+Director[Container]A long-living entity that can spawnaggregators-Aggregator[Container]Model server and collaboratororchestrator-Launches. Setsup globalFederationsettings--Remove link.Link options.Launches.Provides localdatasetShardDescriptors--Remove link.Link options.Sends locallytuned tensorsand trainingmetrics--Remove vertex.Remove link.Link options.Provides FL Plans,Tasks, Models,DataLoaders--Remove link.Link options.Sends tasks andinitial tensors--Remove vertex.Remove link.Link options.Approves, SendsFL experiments--Remove vertex.Remove link.Link options.Communicatesdataset info,Sends statusupdates--Remove vertex.Remove link.Link options.Creates aninstance tomaintain an FLexperiment--Remove link.Link options.Creates aninstance tomaintain an FLexperiment--Remove link.Link options.Sendsinformationabout theFederation.Returns trainingartifacts.--Remove vertex.Remove link.Link options.Registers FLexperiments--Remove vertex.Remove link.Link options. \ No newline at end of file