Incorporated review comment

Signed-off-by: Ishant Thakare <[email protected]>
securefederatedai · Dec 12, 2024 · 7cad9f4 · 7cad9f4
1 parent ef4c505
commit 7cad9f4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 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
@@ -946,7 +946,7 @@
     "The following cells convert the Jupyter notebook into a Python script and create a Template Workspace that can be utilized by Aggregator based Workflow\n",
     "> NOTE: Only Notebook cells that were marked with `#| export` directive shall be included in this Python script\n",
     "\n",
-    "We first import `WorkspaceExport` module and execute `WorkspaceExport.export_agg_based_workspace()` that converts the notebook and generates the template workspace. User is required to specify: \n",
+    "We first import `WorkspaceExport` module and execute `WorkspaceExport.export()` that converts the notebook and generates the template workspace. User is required to specify: \n",
     "1. `notebook_path`: path of the Jupyter notebook that is required to be converted\n",
     "2. `output_workspace`: path where the converted workspace is stored"
    ]
@@ -961,7 +961,7 @@
     "import os\n",
     "from openfl.experimental.workflow.workspace_export import WorkspaceExport\n",
     "\n",
-    "WorkspaceExport.export_agg_based_workspace(\n",
+    "WorkspaceExport.export(\n",
     "    notebook_path='./1001_Workspace_Creation_from_JupyterNotebook.ipynb',\n",
     "    output_workspace=f\"/home/{os.environ['USER']}/generated-workspace\"\n",
     ")"

diff --git a/openfl-tutorials/experimental/workflow/Vertical_FL/TwoPartyWorkspaceCreation.ipynb b/openfl-tutorials/experimental/workflow/Vertical_FL/TwoPartyWorkspaceCreation.ipynb
@@ -340,7 +340,7 @@
     "The following cells convert the Jupyter notebook into a Python script and create a Template Workspace that can be utilized by Aggregator based Workflow\n",
     "> NOTE: Only Notebook cells that were marked with `#| export` directive shall be included in this Python script\n",
     "\n",
-    "We first import `WorkspaceExport` module and execute `WorkspaceExport.export_agg_based_workspace()` that converts the notebook and generates the template workspace. User is required to specify: \n",
+    "We first import `WorkspaceExport` module and execute `WorkspaceExport.export()` that converts the notebook and generates the template workspace. User is required to specify: \n",
     "1. `notebook_path`: path of the Jupyter notebook that is required to be converted\n",
     "2. `output_workspace`: path where the converted workspace is stored"
    ]
@@ -355,7 +355,7 @@
     "import os\n",
     "from openfl.experimental.workflow.workspace_export import WorkspaceExport\n",
     "\n",
-    "WorkspaceExport.export_agg_based_workspace(\n",
+    "WorkspaceExport.export(\n",
     "    notebook_path='./TwoPartyWorkspaceCreation.ipynb',\n",
     "    output_workspace=f\"/home/{os.environ['USER']}/generated-workspace\"\n",
     ")"

diff --git a/openfl/experimental/workflow/workspace_export/export.py b/openfl/experimental/workflow/workspace_export/export.py
@@ -293,8 +293,8 @@ def export_federated(cls, notebook_path: str, output_workspace: str) -> Tuple[st
         return instance.generate_experiment_archive()
 
     @classmethod
-    def export_agg_based_workspace(cls, notebook_path: str, output_workspace: str) -> None:
-        """Exports workspace for Aggregator based workflow.
+    def export(cls, notebook_path: str, output_workspace: str) -> None:
+        """Exports workspace to output_workspace.
 
         Args:
             notebook_path (str): Path to the Jupyter notebook.