Workflow Interface: Remove duplicate tutorials (#1181)

* streamline tutorial Signed-off-by: refai06 <[email protected]> * Resolve broken link Signed-off-by: refai06 <[email protected]> * broken link update Signed-off-by: refai06 <[email protected]> --------- Signed-off-by: refai06 <[email protected]>
securefederatedai · Dec 2, 2024 · f875b78 · f875b78
1 parent c25d144
commit f875b78
Show file tree

Hide file tree

Showing 17 changed files with 38 additions and 1,770 deletions.
diff --git a/openfl-tutorials/experimental/workflow/1001_Workspace_Creation_from_JupyterNotebook.ipynb b/openfl-tutorials/experimental/workflow/1001_Workspace_Creation_from_JupyterNotebook.ipynb
@@ -26,7 +26,7 @@
     "4. User can utilize the experimental `fx` commands to deploy and run the federation seamlessly\n",
     "\n",
     "\n",
-    "The methodology is described using an existing [OpenFL Watermarking Tutorial](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_301_MNIST_Watermarking.ipynb). Let's get started !\n",
+    "The methodology is described using an existing [OpenFL Watermarking Tutorial](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb). Let's get started !\n",
     "\n"
    ]
   },
@@ -747,7 +747,7 @@
     "\n",
     "Users can directly specify a collaborator's private attributes via `collaborator.private_attributes` which is a dictionary where key is name of the attribute and value is the object that is made accessible to collaborator.\n",
     "\n",
-    "For more detailed information on specifying these private attributes, please refer to the first quick start [notebook](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_101_MNIST.ipynb)"
+    "For more detailed information on specifying these private attributes, please refer to the first quick start [notebook](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb)"
    ]
   },
   {

diff --git a/openfl-tutorials/experimental/workflow/101_MNIST.ipynb b/openfl-tutorials/experimental/workflow/101_MNIST.ipynb
@@ -7,7 +7,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 101: Quickstart\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/101_MNIST.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb)"
    ]
   },
   {
@@ -663,7 +663,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your first workflow interface quickstart notebook, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your first workflow interface quickstart notebook, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Using the LocalRuntime Ray Backend for dedicated GPU access\n",
     "- Vertical Federated Learning\n",

diff --git a/openfl-tutorials/experimental/workflow/102_Aggregator_Validation.ipynb b/openfl-tutorials/experimental/workflow/102_Aggregator_Validation.ipynb
@@ -7,7 +7,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 102 - Held out aggregator validation\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_102_Aggregator_Validation.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/102_Aggregator_Validation.ipynb)"
    ]
   },
   {
@@ -16,7 +16,7 @@
    "id": "bd059520",
    "metadata": {},
    "source": [
-    "In this tutorial, we build on the ideas from the [first](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/101_MNIST.ipynb) quick start notebook, and demonstrate how to perform validation on the aggregator after training."
+    "In this tutorial, we build on the ideas from the [first](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb) quick start notebook, and demonstrate how to perform validation on the aggregator after training."
    ]
   },
   {
@@ -186,7 +186,7 @@
     "scrolled": true
    },
    "source": [
-    "Now we come to the updated flow definition. Here we use the same tasks as the [quickstart](https://github.com/psfoley/openfl/blob/experimental-workflow-interface/openfl-tutorials/experimental/Workflow_Interface_MNIST.ipynb), but give the aggregator a `test_loader` as a private attribute. The aggregator will do a forward pass on each of the aggregator's models using it's validation data, and weight the highest accuracy model higher than others.  "
+    "Now we come to the updated flow definition. Here we use the same tasks as the [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb), but give the aggregator a `test_loader` as a private attribute. The aggregator will do a forward pass on each of the aggregator's models using it's validation data, and weight the highest accuracy model higher than others.  "
    ]
   },
   {
@@ -385,7 +385,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Using the LocalRuntime Ray Backend for dedicated GPU access\n",
     "- Vertical Federated Learning\n",

diff --git a/openfl-tutorials/experimental/workflow/103_Cyclic_Institutional_Incremental_Learning.ipynb b/openfl-tutorials/experimental/workflow/103_Cyclic_Institutional_Incremental_Learning.ipynb
@@ -7,7 +7,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 103 - Cyclic Institutional Incremental Learning\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_103_Cyclic_Institutional_Incremental_Learning.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/103_Cyclic_Institutional_Incremental_Learning.ipynb)"
    ]
   },
   {
@@ -195,7 +195,7 @@
     "scrolled": true
    },
    "source": [
-    "Now we come to the updated flow definition. Here we use the same tasks as the [quickstart](https://github.com/psfoley/openfl/blob/experimental-workflow-interface/openfl-tutorials/experimental/Workflow_Interface_MNIST.ipynb), but give the aggregator a `test_loader` as a private attribute. The aggregator will do a forward pass on each of the aggregator's models using it's validation data, and weight the highest accuracy model higher than others.  "
+    "Now we come to the updated flow definition. Here we use the same tasks as the [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb), but give the aggregator a `test_loader` as a private attribute. The aggregator will do a forward pass on each of the aggregator's models using it's validation data, and weight the highest accuracy model higher than others.  "
    ]
   },
   {
@@ -658,7 +658,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Using the LocalRuntime Ray Backend for dedicated GPU access\n",
     "- Vertical Federated Learning\n",

diff --git a/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_CPU.ipynb b/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_CPU.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "source": [
     "# # Workflow Interface 104: Working with Keras on CPU\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/snehal-das/openfl/blob/develop/openfl-tutorials/experimental/104_Keras_MNIST_with_CPU.ipynb)\n",
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_CPU.ipynb)\n",
     "\n",
     "## Training a CNN on CPU using the Workflow Interface and MNIST data.\n",
     "\n",

diff --git a/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_GPU.ipynb b/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_GPU.ipynb
@@ -5,7 +5,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 104: Working with Keras\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/104_Keras_MNIST_with_GPU.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/104_Keras_MNIST_with_GPU.ipynb)"
    ]
   },
   {
@@ -323,7 +323,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your this notebook, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Using the LocalRuntime Ray Backend for dedicated GPU access\n",
     "- Vertical Federated Learning\n",

diff --git a/openfl-tutorials/experimental/workflow/104_MNIST_XPU.ipynb b/openfl-tutorials/experimental/workflow/104_MNIST_XPU.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 104: MNIST XPU\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/104_MNIST_XPU.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/104_MNIST_XPU.ipynb)"
    ]
   },
   {
@@ -701,7 +701,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your first workflow interface quickstart notebook, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your first workflow interface quickstart notebook, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Using the LocalRuntime Ray Backend for dedicated GPU access\n",
     "- Vertical Federated Learning\n",

diff --git a/openfl-tutorials/experimental/workflow/201_Exclusive_GPUs_with_Ray.ipynb b/openfl-tutorials/experimental/workflow/201_Exclusive_GPUs_with_Ray.ipynb
@@ -7,7 +7,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 201: Using Ray to request exclusive GPUs\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/201_Exclusive_GPUs_with_Ray.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/201_Exclusive_GPUs_with_Ray.ipynb)"
    ]
   },
   {
@@ -288,7 +288,7 @@
    "id": "49c4afa8",
    "metadata": {},
    "source": [
-    "In this step we define entities necessary to run the flow and create a function which returns dataset as private attributes of collaborator. As described in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_101_MNIST.ipynb) we define entities necessary for the flow.\n",
+    "In this step we define entities necessary to run the flow and create a function which returns dataset as private attributes of collaborator. As described in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb) we define entities necessary for the flow.\n",
     "\n",
     "To request GPU(s) with ray-backend, we specify `num_gpus=0.5` as the argument while instantiating Collaborator, this will reserve 0.5 GPU for each of the 2 collaborators and therefore require a dedicated GPU for the experiment. Tune this based on your use case, for example `num_gpus=0.5` for an experiment with 4 collaborators will require 2 dedicated GPUs. **NOTE:** Collaborator cannot span over multiple GPUs, for example `num_gpus=0.4` with 5 collaborators will require 3 dedicated GPUs. In this case collaborator 1 and 2 use GPU#1, collaborator 3 and 4 use GPU#2, and collaborator 5 uses GPU#3."
    ]
@@ -614,7 +614,7 @@
    "metadata": {},
    "source": [
     "# Congratulations!\n",
-    "Now that you've completed your **workflow interface 201 tutorial**, see some of the more advanced things you can do in our [other tutorials](broken_link), including:\n",
+    "Now that you've completed your **workflow interface 201 tutorial**, see some of the more advanced things you can do in our [other tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow), including:\n",
     "\n",
     "- Vertical Federated Learning\n",
     "- Model Watermarking\n",

diff --git a/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb b/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb
@@ -8,7 +8,7 @@
    "source": [
     "# Workflow Interface 301: Watermarking\n",
     "\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/301_MNIST_Watermarking.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb)"
    ]
   },
   {
@@ -432,7 +432,7 @@
    "id": "c917b085",
    "metadata": {},
    "source": [
-    "Let us now define the Workflow for Watermark embedding. Here we use the same tasks as the [quickstart](https://github.com/psfoley/openfl/blob/experimental-workflow-interface/openfl-tutorials/experimental/Workflow_Interface_MNIST.ipynb), and define following additional steps for Watermarking\n",
+    "Let us now define the Workflow for Watermark embedding. Here we use the same tasks as the [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb), and define following additional steps for Watermarking\n",
     "- PRE-TRAIN (watermark_retrain): At the start (once), initial model is trained on Watermark dataset for a specified number of epochs \n",
     "- RE-TRAIN (watermark_pretrain): Every training round, Aggregated model is retrained on Watermark dataset until a desired acc threshold is reached or max number of retrain rounds are expired\n",
     "\n",
@@ -684,7 +684,7 @@
    "source": [
     "In the `FederatedFlow_MNIST_Watermarking` definition above, you will notice that certain attributes of the flow were not initialized, namely the `watermark_data_loader` for Aggregator and `train_loader`, `test_loader` for the Collaborators. \n",
     "\n",
-    "- Collaborator attributes are created in the same manner as described in [quickstart](https://github.com/psfoley/openfl/blob/experimental-workflow-interface/openfl-tutorials/experimental/Workflow_Interface_101_MNIST.ipynb)\n",
+    "- Collaborator attributes are created in the same manner as described in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb)\n",
     "\n",
     "- `watermark_data_loader` is created as a **private attribute** of the Aggregator which is set by `callable_to_initialize_aggregator_private_attributes` callable function. It is exposed only via the runtime. This property enables the Watermark dataset to be hidden from the collaborators as Aggregator private attributes are filtered before the state is transferred to Collaborators (in the same manner as Collaborator private attributes are hidden from Aggregator)\n",
     "\n",

diff --git a/openfl-tutorials/experimental/workflow/401_FedProx_with_Synthetic_nonIID.ipynb b/openfl-tutorials/experimental/workflow/401_FedProx_with_Synthetic_nonIID.ipynb
@@ -6,7 +6,7 @@
    "metadata": {},
    "source": [
     "# Workflow Interface 401: Synthetic non-IID Dataset with FedProx Optimizer\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_401_FedProx_with_Synthetic_nonIID.ipynb)"
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/experimental/workflow/401_FedProx_with_Synthetic_nonIID.ipynb)"
    ]
   },
   {
@@ -342,7 +342,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Let us now define the Workflow for our experiment. Here we use the methodology as provided in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_101_MNIST.ipynb), and define the workflow consisting of following steps:\n",
+    "Let us now define the Workflow for our experiment. Here we use the methodology as provided in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb), and define the workflow consisting of following steps:\n",
     "-\t`start`: Start of the flow \n",
     "-\t`compute_loss_and_accuracy`: Compute Train Loss and Test Accuracy on aggregated model. Performed *foreach collaborator* in Federation\n",
     "-\t`gather_results_and_take_weighted_average`: Collect train loss, and test accuracy metrics for each collaborator and take weighted average to compute the *Aggregated* Train Loss and Test Accuracy. Performed on Aggregator\n",
@@ -574,7 +574,7 @@
    "source": [
     "# Setup Federation\n",
     "\n",
-    "In this step we define entities necessary to run the flow and create a function which returns dataset as private attributes of collaborator. As described in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_101_MNIST.ipynb) we define entities necessary for the flow."
+    "In this step we define entities necessary to run the flow and create a function which returns dataset as private attributes of collaborator. As described in [quickstart](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/101_MNIST.ipynb) we define entities necessary for the flow."
    ]
   },
   {