Fix hierarchical stats documentation (NVIDIA#2882)

This patch fixes few typos in the hierarchical stats documentation and fixes the prepare_data python script.
NAEV95 · Aug 30, 2024 · ca02402 · ca02402
1 parent 9bb5879
commit ca02402
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 6 deletions.
diff --git a/examples/advanced/federated-statistics/df_stats.ipynb b/examples/advanced/federated-statistics/df_stats.ipynb
@@ -164,7 +164,7 @@
    "source": [
     "**Run Job using Simulator CLI**\n",
     "\n",
-    "From a **terminal** one can also the following equivallent CLI\n",
+    "From a **terminal** one can also the following equivalent CLI\n",
     "\n",
     "```\n",
     "nvflare simulator df_stats/jobs/df_stats -w /tmp/nvflare/df_stats -n 2 -t 2\n",

diff --git a/examples/advanced/federated-statistics/hierarchical_stats/README.md b/examples/advanced/federated-statistics/hierarchical_stats/README.md
@@ -29,7 +29,7 @@ In this example, we are using synthetic anonymous students scores datasets gener
 Run the script `prepare_data.sh` that generates 7 different datasets each having random number of entries between 1000 to 2000. Each entry in the datasets has three columns - `Pass`, `Fail` and `Percentage`. `Pass`/`Fail` represents whether the particular student passed or failed the exam and `Percentage` represents the overall percentage marks scored by the student.
 
 ```shell
-prepare_data.sh
+./prepare_data.sh
 ```
 it should show something like
 ```
@@ -53,7 +53,7 @@ With FL simulator, we can just run the example with CLI command
 
 
 ```
-cd NVFlare/examples/advanced/hierarchical_stats
+cd NVFlare/examples/advanced/federated-statistics
 nvflare simulator hierarchical_stats/jobs/hierarchical_stats -w /tmp/nvflare/hierarchical_stats/ -n 7 -t 7 -c university-1,university-2,university-3,university-4,university-5,university-6,university-7
 ```
 

diff --git a/examples/advanced/federated-statistics/hierarchical_stats/hierarchical_stats.ipynb b/examples/advanced/federated-statistics/hierarchical_stats/hierarchical_stats.ipynb
@@ -120,10 +120,10 @@
    "source": [
     "**Run Job using Simulator CLI**\n",
     "\n",
-    "From a **terminal** one can also the following equivallent CLI\n",
+    "From a **terminal** one can also the following equivalent CLI\n",
     "\n",
     "```\n",
-    "cd NVFlare/examples/advanced/hierarchical_stats\n",
+    "cd NVFlare/examples/advanced/federated-statistics\n",
     "nvflare simulator hierarchical_stats/jobs/hierarchical_stats -w /tmp/nvflare/hierarchical_stats/ -n 7 -t 7 -c university-1,university-2,university-3,university-4,university-5,university-6,university-7\n",
     "\n",
     "```\n",

diff --git a/examples/advanced/federated-statistics/hierarchical_stats/utils/prepare_data.py b/examples/advanced/federated-statistics/hierarchical_stats/utils/prepare_data.py
@@ -67,3 +67,17 @@ def prepare_data():
         )
 
     print("\nDone preparing data.")
+
+
+def main():
+    prog_name = "data_utils"
+    parser, args = parse_args(prog_name)
+
+    if args.prepare_data:
+        prepare_data()
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/advanced/federated-statistics/image_stats.ipynb b/examples/advanced/federated-statistics/image_stats.ipynb
@@ -156,7 +156,7 @@
    "source": [
     "**Run Job using Simulator CLI**\n",
     "\n",
-    "From a **terminal** one can also the following equivallent CLI\n",
+    "From a **terminal** one can also the following equivalent CLI\n",
     "\n",
     "```\n",
     "nvflare simulator image_stats/jobs/image_stats -w /tmp/nvflare/workspace/image_stats -n 4 -t 4\n",