Merge branch 'develop' into torch-update

securefederatedai · Jan 7, 2025 · a59cbeb · a59cbeb
2 parents 816468d + 6bf229e
commit a59cbeb
Show file tree

Hide file tree

Showing 61 changed files with 717 additions and 529 deletions.
diff --git a/.github/workflows/docker-bench-security.yml b/.github/workflows/docker-bench-security.yml
@@ -2,7 +2,6 @@ name: Docker Bench for Security
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/double_ws_export.yml b/.github/workflows/double_ws_export.yml
@@ -5,7 +5,6 @@ name: Double workspace export
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/experimental_workflow_tests.yml b/.github/workflows/experimental_workflow_tests.yml
@@ -2,9 +2,10 @@ name: Workflow Interface Tests
 
 on:
   push:
-    branches: [ develop ]
+    branches: 
+      - develop
+      - v1.7.x
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/gandlf.yml b/.github/workflows/gandlf.yml
@@ -5,7 +5,6 @@ name: GaNDLF TaskRunner
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/hadolint.yml b/.github/workflows/hadolint.yml
@@ -5,7 +5,6 @@ name: Hadolint Security Scan
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/interactive-kvasir.yml b/.github/workflows/interactive-kvasir.yml
@@ -5,7 +5,6 @@ name: Interactive API - Pytorch Kvasir UNet
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/interactive-tensorflow.yml b/.github/workflows/interactive-tensorflow.yml
@@ -5,7 +5,6 @@ name: Interactive API - Tensorflow MNIST
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -5,7 +5,6 @@ name: Check code format
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/openfl-docker-build.yml b/.github/workflows/openfl-docker-build.yml
@@ -0,0 +1,47 @@
+name: Build and Push Openfl Docker Image
+
+on:
+  push:
+    branches: 
+      - develop
+      - v1.7.x
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to tag the Docker image with'
+        required: false
+        default: 'latest'
+
+env:
+  VERSION: ${{ github.ref == 'refs/heads/develop' && 'latest' || '1.7' }}
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:      
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+    - name: Log in to GitHub Container Registry
+      uses: docker/login-action@v2
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and Push OpenFL Base Image
+      uses: docker/build-push-action@v4
+      with:
+        context: .
+        file: openfl-docker/Dockerfile.base
+        push: true
+        tags: |
+          ghcr.io/${{ github.repository }}/openfl:${{ github.event.inputs.version || 'latest' }}
diff --git a/.github/workflows/pki.yml b/.github/workflows/pki.yml
@@ -5,7 +5,6 @@ name: Private Key Infrastructure
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/pytest_coverage.yml b/.github/workflows/pytest_coverage.yml
@@ -5,7 +5,6 @@ name: Pytest and code coverage
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
   workflow_dispatch:
 

diff --git a/.github/workflows/straggler-handling.yml b/.github/workflows/straggler-handling.yml
@@ -5,7 +5,6 @@ name: Straggler Handling Test
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/taskrunner.yml b/.github/workflows/taskrunner.yml
@@ -5,7 +5,6 @@ name: TaskRunner
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/taskrunner_eden_pipeline.yml b/.github/workflows/taskrunner_eden_pipeline.yml
@@ -5,7 +5,6 @@ name: TaskRunner (Eden Compression)
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/tr_docker_gramine_direct.yml b/.github/workflows/tr_docker_gramine_direct.yml
@@ -3,7 +3,6 @@ name: TaskRunner (docker/gramine-direct)
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/tr_docker_native.yml b/.github/workflows/tr_docker_native.yml
@@ -3,7 +3,6 @@ name: TaskRunner (docker/native)
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:

diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml
@@ -1,9 +1,10 @@
 name: Trivy
 on:
   push:
-    branches: [ develop ]
+    branches: 
+      - develop
+      - v1.7.x
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 jobs:
   build:

diff --git a/.github/workflows/wf_functional_e2e.yml b/.github/workflows/wf_functional_e2e.yml
@@ -5,7 +5,6 @@ name: Workflow_Functional_E2E
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
   workflow_dispatch:

diff --git a/.github/workflows/workflow_interface_101_mnist.yml b/.github/workflows/workflow_interface_101_mnist.yml
@@ -6,7 +6,6 @@ name: Workflow Interface 101 MNIST Notebook
 
 on:
   pull_request:
-    branches: [ develop ]
     types: [opened, synchronize, reopened, ready_for_review]
 
   workflow_dispatch:

diff --git a/docs/openfl.callbacks.rst b/docs/openfl.callbacks.rst
@@ -0,0 +1,16 @@
+``openfl.callbacks`` module
+===========================
+
+.. currentmodule:: openfl.callbacks
+
+.. automodule:: openfl.callbacks
+
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   Callback
+   CallbackList
+   LambdaCallback
+   MetricWriter
+   MemoryProfiler
diff --git a/docs/openfl.rst b/docs/openfl.rst
@@ -1,6 +1,6 @@
 .. currentmodule:: openfl
 
-Public API: ``openfl`` package
+API Reference: ``openfl``
 ===========================
 
 Subpackages
@@ -10,6 +10,7 @@ Subpackages
     :maxdepth: 1
 
     openfl.component
+    openfl.callbacks
     openfl.cryptography
     openfl.experimental
     openfl.databases

diff --git a/...orkspace/experimental/workflow/AggregatorBasedWorkflow/101_torch_cnn_mnist/plan/plan.yaml b/...orkspace/experimental/workflow/AggregatorBasedWorkflow/101_torch_cnn_mnist/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :

diff --git a/...-workspace/experimental/workflow/AggregatorBasedWorkflow/101_torch_cnn_mnist/src/utils.py b/...-workspace/experimental/workflow/AggregatorBasedWorkflow/101_torch_cnn_mnist/src/utils.py
diff --git a/...ce/experimental/workflow/AggregatorBasedWorkflow/102_aggregator_validation/plan/plan.yaml b/...ce/experimental/workflow/AggregatorBasedWorkflow/102_aggregator_validation/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :

diff --git a/...pace/experimental/workflow/AggregatorBasedWorkflow/102_aggregator_validation/src/utils.py b/...pace/experimental/workflow/AggregatorBasedWorkflow/102_aggregator_validation/src/utils.py
diff --git a/...fl-workspace/experimental/workflow/AggregatorBasedWorkflow/104_keras_mnist/plan/plan.yaml b/...fl-workspace/experimental/workflow/AggregatorBasedWorkflow/104_keras_mnist/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :

diff --git a/openfl-workspace/experimental/workflow/AggregatorBasedWorkflow/104_keras_mnist/src/utils.py b/openfl-workspace/experimental/workflow/AggregatorBasedWorkflow/104_keras_mnist/src/utils.py
diff --git a/...rimental/workflow/AggregatorBasedWorkflow/301_torch_cnn_mnist_watermarking/plan/plan.yaml b/...rimental/workflow/AggregatorBasedWorkflow/301_torch_cnn_mnist_watermarking/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :

diff --git a/...perimental/workflow/AggregatorBasedWorkflow/301_torch_cnn_mnist_watermarking/src/utils.py b/...perimental/workflow/AggregatorBasedWorkflow/301_torch_cnn_mnist_watermarking/src/utils.py
diff --git a/...orkflow/AggregatorBasedWorkflow/501_pytorch_tinyimagenet_transfer_learning/plan/plan.yaml b/...orkflow/AggregatorBasedWorkflow/501_pytorch_tinyimagenet_transfer_learning/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :

diff --git a/.../workflow/AggregatorBasedWorkflow/501_pytorch_tinyimagenet_transfer_learning/src/utils.py b/.../workflow/AggregatorBasedWorkflow/501_pytorch_tinyimagenet_transfer_learning/src/utils.py
diff --git a/openfl-workspace/experimental/workflow/AggregatorBasedWorkflow/vertical_fl/plan/plan.yaml b/openfl-workspace/experimental/workflow/AggregatorBasedWorkflow/vertical_fl/plan/plan.yaml
@@ -6,8 +6,6 @@ aggregator :
   template : openfl.experimental.workflow.component.aggregator.Aggregator
   settings :
     rounds_to_train     : 1
-    log_metric_callback :
-      template : src.utils.write_metric
 
 
 collaborator :