Azure-Samples
diff --git a/‎.github/actions/submit-aml-factory-pipeline/action.yaml‎ renamed to ‎.github/actions/submit-aml-scatter-gather-pipeline/action.yaml‎
Lines changed: 4 additions & 4 deletions b/‎.github/actions/submit-aml-factory-pipeline/action.yaml‎ renamed to ‎.github/actions/submit-aml-scatter-gather-pipeline/action.yaml‎
Lines changed: 4 additions & 4 deletions
diff --git a/‎.github/workflows/pipeline-e2e-test.yaml‎
Lines changed: 14 additions & 14 deletions b/‎.github/workflows/pipeline-e2e-test.yaml‎
Lines changed: 14 additions & 14 deletions
diff --git a/‎.github/workflows/release-branch-test.yaml‎
Lines changed: 10 additions & 10 deletions b/‎.github/workflows/release-branch-test.yaml‎
Lines changed: 10 additions & 10 deletions
diff --git a/‎.gitignore‎
Lines changed: 3 additions & 0 deletions b/‎.gitignore‎
Lines changed: 3 additions & 0 deletions
diff --git a/‎CHANGELOG.md‎
Lines changed: 24 additions & 0 deletions b/‎CHANGELOG.md‎
Lines changed: 24 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 10 additions & 0 deletions b/‎README.md‎
Lines changed: 10 additions & 0 deletions
diff --git a/‎docs/README.md‎
Lines changed: 8 additions & 4 deletions b/‎docs/README.md‎
Lines changed: 8 additions & 4 deletions
@@ -1,5 +1,5 @@
-name: Submit example factory pipeline
-description: Submit example factory pipeline in AML
+name: Submit example scatter-gather pipeline
+description: Submit example scatter-gather pipeline in AML
 inputs:
   client-id:
     description: Client ID of the service principal
@@ -46,6 +46,6 @@ runs:
       shell: bash
       run: pip install -r examples/pipelines/requirements.txt
 
-    - name: Submit fl_cross_silo_factory pipeline
+    - name: Submit fl_cross_silo_scatter_gather pipeline
       shell: bash
-      run: python examples/pipelines/fl_cross_silo_factory/submit.py --subscription_id ${{ inputs.subscription-id }} --resource_group ${{ inputs.resource-group }} --workspace_name ${{ inputs.workspace-name }} --example ${{ inputs.example }} --ignore_validation --wait || [ $? == 5 ]
+      run: python examples/pipelines/fl_cross_silo_scatter_gather/submit.py --subscription_id ${{ inputs.subscription-id }} --resource_group ${{ inputs.resource-group }} --workspace_name ${{ inputs.workspace-name }} --example ${{ inputs.example }} --ignore_validation --wait || [ $? == 5 ]
@@ -118,7 +118,7 @@ jobs:
         workspace-name: aml-fl1${{ github.run_attempt }}${{ github.run_id }}
         example: MNIST
 
-  open-sandbox-factory-helloworld-test:
+  open-sandbox-scatter-gather-helloworld-test:
     needs: open-sandbox-test
     runs-on: ubuntu-latest
     permissions:
@@ -127,8 +127,8 @@ jobs:
 
     - uses: actions/checkout@v2
 
-    - name: Submit Helloworld example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit Helloworld example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
@@ -137,16 +137,16 @@ jobs:
         workspace-name: aml-fl1${{ github.run_attempt }}${{ github.run_id }}
         example: HELLOWORLD
 
-  open-sandbox-factory-mnist-test:
-    needs: open-sandbox-factory-helloworld-test
+  open-sandbox-scatter-gather-mnist-test:
+    needs: open-sandbox-scatter-gather-helloworld-test
     runs-on: ubuntu-latest
     permissions:
       id-token: write
     steps:
     - uses: actions/checkout@v2
 
-    - name: Submit MNIST example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit MNIST example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
@@ -297,16 +297,16 @@ jobs:
         workspace-name: aml-fl2${{ github.run_attempt }}${{ github.run_id }}
         example: MNIST
 
-  vnet-sandbox-factory-helloworld-test:
+  vnet-sandbox-scatter-gather-helloworld-test:
     needs: vnet-sandbox-test
     runs-on: ubuntu-latest
     permissions:
       id-token: write
     steps:
     - uses: actions/checkout@v2
 
-    - name: Submit Helloworld example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit Helloworld example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
@@ -315,16 +315,16 @@ jobs:
         workspace-name: aml-fl2${{ github.run_attempt }}${{ github.run_id }}
         example: HELLOWORLD
 
-  vnet-sandbox-factory-mnist-test:
-    needs: vnet-sandbox-factory-helloworld-test
+  vnet-sandbox-scatter-gather-mnist-test:
+    needs: vnet-sandbox-scatter-gather-helloworld-test
     runs-on: ubuntu-latest
     permissions:
       id-token: write
     steps:
     - uses: actions/checkout@v2
 
-    - name: Submit MNIST example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit MNIST example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
 
@@ -23,7 +23,7 @@ jobs:
       components-mnist: ${{ steps.filter.outputs.components-mnist }}
       components-utils: ${{ steps.filter.outputs.components-utils }}
       literal: ${{ steps.filter.outputs.literal }}
-      factory: ${{ steps.filter.outputs.factory }}
+      scatter-gather: ${{ steps.filter.outputs.scatter-gather }}
       components-pneumonia: ${{ steps.filter.outputs.components-pneumonia }}
       components-ner: ${{ steps.filter.outputs.components-ner }}
       components-ccfraud: ${{ steps.filter.outputs.components-ccfraud }}
@@ -56,8 +56,8 @@ jobs:
             - 'examples/components/utils/**'
           literal:
             - 'examples/pipelines/fl_cross_silo_literal/**'
-          factory:
-            - 'examples/pipelines/fl_cross_silo_factory/**'
+          scatter-gather:
+            - 'examples/pipelines/fl_cross_silo_scatter_gather/**'
           components-pneumonia:
             - 'examples/components/PNEUMONIA/**'
           components-ner:
@@ -149,18 +149,18 @@ jobs:
         workspace-name: ${{ secrets.AML_WORKSPACE_NAME }}
         example: HELLOWORLD
 
-  factory-helloworld-test:
+  scatter-gather-helloworld-test:
     runs-on: ubuntu-latest
     needs: paths-filter
-    if: ${{ (needs.paths-filter.outputs.components-helloworld == 'true') || (needs.paths-filter.outputs.factory == 'true') }}    
+    if: ${{ (needs.paths-filter.outputs.components-helloworld == 'true') || (needs.paths-filter.outputs.scatter-gather == 'true') }}    
     permissions:
       id-token: write
     steps:
 
     - uses: actions/checkout@v2
 
-    - name: Submit Helloworld example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit Helloworld example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
@@ -188,7 +188,7 @@ jobs:
         workspace-name: ${{ secrets.AML_WORKSPACE_NAME }}
         example: MNIST
 
-  factory-mnist-test:
+  scatter-gather-mnist-test:
     runs-on: ubuntu-latest
     needs: paths-filter
     if: ${{ needs.paths-filter.outputs.components-mnist == 'true' }}
@@ -198,8 +198,8 @@ jobs:
 
     - uses: actions/checkout@v2
 
-    - name: Submit MNIST example using the factory code
-      uses: ./.github/actions/submit-aml-factory-pipeline
+    - name: Submit MNIST example using the scatter-gather code
+      uses: ./.github/actions/submit-aml-scatter-gather-pipeline
       with:
         client-id: ${{ secrets.AZURE_CLIENT_ID }}
         tenant-id: ${{ secrets.AZURE_TENANT_ID }}
 
@@ -133,3 +133,6 @@ config.json
 
 # for ignoring test jobs
 /examples/pipelines/test*
+
+# for ignoring local sandbox files for debugging/testing
+/sandbox/*
@@ -1,5 +1,29 @@
 # FL Accelerator Changelog
 
+##  February 2023 release
+
+We are excited to announce the release of the February iteration of our [FL Accelerator repository](https://github.com/Azure-Samples/azure-ml-federated-learning).
+
+Some of the major updates we have made include the launch of a vertical federated learning feature, an FL pipeline that offers a native AML FL experience integrated with the factory engine, and benchmark results that reveal a comprehensive comparison between FL and non-FL experiments.
+
+### FL Experience
+- Implemented _Vertical Federated Learning_ and offered a [tutorial](./docs/tutorials/vertical-fl.md) to run MNIST or CCFRAUD examples.
+- Introduced a [scatter-gather](./docs/tutorials/literal-scatter-gather-tutorial.md) pipeline that delivers a real AML FL native experience.
+- Conducted a comprehensive comparison b/w FL and non-FL experiments and the benchmark report can be accessed [here](./docs/concepts/benchmarking.md).
+
+### Provisioning
+- Provided [instructions](./docs/tutorials/update-local-data-to-silo-storage-account.md) and a script to facilitate the upload of local data to a silo storage.
+- Incremental improvements:
+  - Enhanced the network security rules and minimized the workspace dependencies for provisioning resources.
+<!-- ### Documentation -->
+
+<!-- ### Repository structure
+-->
+
+To get started, go [here](./docs/quickstart.md)!
+
+If you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/Azure-Samples/azure-ml-federated-learning/issues).
+
 ##  January 2023 release
 
 We are excited to announce the release of the January iteration of our [FL Accelerator repository](https://github.com/Azure-Samples/azure-ml-federated-learning).
 
@@ -12,6 +12,7 @@ This repo provides some code samples for running a federated learning pipeline i
 - [Real world examples](#real-world-examples)
 - [FL Frameworks](#fl-frameworks)
 - [Documentation](#documentation)
+- [Real-world example benchmarks](#real-world-example-benchmarks)
 - [Need Support?](#need-support)
 - [Contributing](#contributing)
 
@@ -51,6 +52,15 @@ If you are already using a specific FL framework, you can port your code to work
 
 Please find a full documentation of this project [**here**](docs/README.md).
 
+### Real-world example benchmarks
+
+A benchmarking analysis is performed for each real-world example to understand the validy, efficiency and scalability of our implementation of FL:
+
+|  Training overhead  | Model performance  | Scalability |
+|:-:|:-:|:-:|
+| [![overhead icon](./docs/pics/pneumonia_time.jpg)](./docs/concepts/benchmarking.md/#21-training-overhead)| [![performance icon](./docs/pics/pneumonia_acc.jpg)](./docs/concepts/benchmarking.md/#22-model-performance)| [![scala icon](./docs/pics/pneumonia_ddp.jpg)](./docs/concepts/benchmarking.md/#23-scalability-with-training)
+
+
 ### Need Support?
 
 Please check the [**troubleshooting guide**](./docs/troubleshoot.md) for possible solutions. If you are unable to find a solution, please open an issue in this repository.
 
@@ -22,8 +22,9 @@
 - [Tutorials](#tutorials)
   - [What this repo has to offer?](#what-this-repo-has-to-offer)
   - [Provisioning guide](#provisioning-guide)
-  - [How to adapt the "literal" and the "factory" code for your own scenario](#how-to-adapt-the-literal-and-the-factory-code-for-your-own-scenario)
+  - [How to adapt the "literal" and the "scatter-gather" code for your own scenario](#how-to-adapt-the-literal-and-the-scatter-gather-code-for-your-own-scenario)
   - [Read local data in an on-premises Kubernetes silo](#read-local-data-in-an-on-premises-kubernetes-silo)
+  - [Upload local data to silo storage account](#upload-local-data-to-silo-storage-account)
 - [Troubleshooting guide](#troubleshooting-guide)
 
 ## Motivation
@@ -44,7 +45,7 @@ To know more about the resource provisioning alternatives, please go to the prov
 
 ## Real-world examples
 
-In addition to the [literal](../examples/pipelines/fl_cross_silo_literal/) and [factory](../examples/pipelines/fl_cross_silo_factory/) sample experiments, we also provide examples based on real-world applications.
+In addition to the [literal](../examples/pipelines/fl_cross_silo_literal/) and [scatter-gather](../examples/pipelines/fl_cross_silo_scatter_gather/) sample experiments, we also provide examples based on real-world applications.
 
 > Note: The `upload-data` scripts are only included in the examples for the convenience of executing the FL examples. Please ignore this section if you are performing an actual FL experiment for your scenario.
 
@@ -123,9 +124,9 @@ This repo provides some code samples for running a federated learning pipeline i
 
 This guide will help you adapt your own setup depending on your provisioning strategy and your constraints. See [here](./provisioning/README.md) for detailed instructions.
 
-## How to adapt the "literal" and the "factory" code for your own scenario
+## How to adapt the "literal" and the "scatter-gather" code for your own scenario
 
-The complete tutorial can be found [**here**](./tutorials/literal-factory-tutorial.md)
+The complete tutorial can be found [**here**](./tutorials/literal-scatter-gather-tutorial.md)
 
 ## Read local data in an on-premises Kubernetes silo
 
@@ -134,6 +135,9 @@ This tutorial will show you how to access, within an Azure ML job running on an
 ## Differential privacy for cross-silo horizontal federated learning
 The complete tutorial can be found [**here**](./tutorials/dp-for-cross-silo-horizontal-fl.md).
 
+## Upload local data to silo storage account
+This tutorial will teach you how to upload local data to a silo storage account. We will be using a CLI job to do the upload. The job will run on the silo compute, which does have access to the silo storage account. See detailed instructions [here](./tutorials/update-local-data-to-silo-storage-account.md).
+
 # Troubleshooting guide
 
 If you experience an issue using this repository, please check the [**troubleshooting guide**](./troubleshoot.md) for possible solutions. If you are unable to find a solution, please open an issue in this repository.