To prevent confusion, include a backward reference to the README file…

… within the notebook. Signed-off-by: yuliasherman <[email protected]>
securefederatedai · Feb 19, 2025 · 23607f2 · 23607f2
1 parent 6bd344a
commit 23607f2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/...perimental/workflow/FederatedRuntime/101_MNIST/workspace/101_MNIST_FederatedRuntime.ipynb b/...perimental/workflow/FederatedRuntime/101_MNIST/workspace/101_MNIST_FederatedRuntime.ipynb
@@ -26,7 +26,9 @@
     "2. Enable creation of workspace content by annotating Jupyter notebook with export directives. Explore [1001 Workspace Creation from JupyterNotebook](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/1001_Workspace_Creation_from_JupyterNotebook.ipynb) for insights\n",
     "3. **Deploy** the experiment on Federated infrastructure (Director and Envoy nodes) using `FederatedRuntime`\n",
     "\n",
-    "Let's get started !\n"
+    "**&#9888; Attention** Please make sure you have followed the steps described in the [README.md](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/README.md)\n",
+    "\n",
+    "Let's get started !"
    ]
   },
   {
@@ -71,7 +73,9 @@
    "metadata": {},
    "source": [
     "### Installing Pre-requisties\n",
-    "We start by installing OpenFL and dependencies of the workflow interface. These dependencies are exported and become requirements for the Federated Learning Environment "
+    "We start by installing OpenFL and dependencies of the workflow interface. These dependencies are exported and become requirements for the Federated Learning Environment.\n",
+    "\n",
+    "**&#9888; Attention** As per [README.md](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/README.md), the Director/Envoy infrastructure must be set up before beginning the experiment."
    ]
   },
   {

diff --git a/...ental/workflow/FederatedRuntime/301_MNIST_Watermarking/workspace/MNIST_Watermarking.ipynb b/...ental/workflow/FederatedRuntime/301_MNIST_Watermarking/workspace/MNIST_Watermarking.ipynb
@@ -14,13 +14,13 @@
    "id": "3b7357ef",
    "metadata": {},
    "source": [
-    "This tutorial is based on the LocalRuntime example [301_MNIST_Watermarking](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb). It has been adapted to demonstrate the FederatedRuntime version of the watermarking workflow. In this tutorial, we will guide you through the process of deploying the watermarking example within a federation, showcasing how to transition from a local setup to a federated environment effectively."
+    "This tutorial is based on the LocalRuntime example [301_MNIST_Watermarking](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/301_MNIST_Watermarking.ipynb). It has been adapted to demonstrate the FederatedRuntime version of the watermarking workflow. In this tutorial, we will guide you through the process of deploying the watermarking example within a federation, showcasing how to transition from a local setup to a federated environment effectively.\n",
+    "\n",
+    "**&#9888; Attention:** Please make sure you have followed the steps described in the [README.md](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermarking/README.md)"
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
-   "id": "a4394089",
    "metadata": {},
    "source": [
     "# Getting Started"
@@ -88,7 +88,9 @@
    "id": "9a6ae8e2",
    "metadata": {},
    "source": [
-    "We now define our model, optimizer, and some helper functions like we would for any other deep learning experiment \n",
+    "**&#9888; Attention:** As per [README.md](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermarking/README.md), the Director/Envoy infrastructure must be set up before beginning the experiment.\n",
+    "\n",
+    "We now define our model, optimizer, and some helper functions like we would for any other deep learning experiment.\n",
     "\n",
     "> This cell and all the subsequent cells are important ingredients of the Federated Learning experiment and therefore annotated with the `#| export` directive"
    ]