From c036dbaa024f44524bca899728f241c0689933f6 Mon Sep 17 00:00:00 2001 From: sowmyasri Date: Fri, 23 Aug 2024 11:40:22 +0200 Subject: [PATCH 1/5] added documentation for using the CLI command for train and validate ebtryooint --- docs/projects.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/projects.rst b/docs/projects.rst index 8e8592532..afa4e9317 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -136,6 +136,13 @@ project): python train.py ../seed.npz ../model_update.npz --data_path ../data/mnist.npz python validate.py ../model_update.npz ../validation.json --data_path ../data/mnist.npz +You can also test *train* and *validate* entrypoint using CLI command: + +.. code-block:: bash + + fedn run train --path client --input --output + fedn run validate --path client --input --output + Note that we here assume execution in the correct Python environment. To deploy a project to FEDn (Studio or pseudo-local) we simply compress the compute package as a .tgz file. using fedn command line tool or manually: From b006edbc0e5056bda42101bef0f23c27fd698829 Mon Sep 17 00:00:00 2001 From: sowmyasri Date: Wed, 4 Sep 2024 14:22:26 +0200 Subject: [PATCH 2/5] Merge clean up --- docs/projects.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/projects.rst b/docs/projects.rst index 77e222262..8a4d5b65a 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -397,7 +397,6 @@ You can also test *train* and *validate* entrypoint using CLI command: Note that we here assume execution in the correct Python environment. -To deploy a project to FEDn (Studio or pseudo-local) we simply compress the compute package as a .tgz file. using fedn command line tool or manually: To run a project on FEDn we compress the entire client folder as a .tgz file. There is a utility command in the FEDn CLI to do this: .. code-block:: bash From 0ac7664f4a6108defa13b055fed10421e420b76d Mon Sep 17 00:00:00 2001 From: sowmyasri Date: Wed, 4 Sep 2024 14:35:07 +0200 Subject: [PATCH 3/5] fixed the merge issue and order of commands --- docs/projects.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/projects.rst b/docs/projects.rst index 8a4d5b65a..1bf19c980 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -385,9 +385,6 @@ Then, standing inside the 'client folder', you can test *train* and *validate* b python train.py ../seed.npz ../model_update.npz --data_path data/clients/1/mnist.pt python validate.py ../model_update.npz ../validation.json --data_path data/clients/1/mnist.pt -Packaging for training on FEDn -=============================== - You can also test *train* and *validate* entrypoint using CLI command: .. code-block:: bash @@ -395,7 +392,8 @@ You can also test *train* and *validate* entrypoint using CLI command: fedn run train --path client --input --output fedn run validate --path client --input --output -Note that we here assume execution in the correct Python environment. +Packaging for training on FEDn +=============================== To run a project on FEDn we compress the entire client folder as a .tgz file. There is a utility command in the FEDn CLI to do this: From 1f62f1a90dc371086f2f89ca98df6cb023e15dcb Mon Sep 17 00:00:00 2001 From: sowmyasri Date: Thu, 5 Sep 2024 16:23:54 +0200 Subject: [PATCH 4/5] added note brfore executing the entry points --- docs/projects.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/projects.rst b/docs/projects.rst index 1bf19c980..498e11d37 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -387,10 +387,12 @@ Then, standing inside the 'client folder', you can test *train* and *validate* b You can also test *train* and *validate* entrypoint using CLI command: +.. note:: Before running the fedn run train or fedn run validate commands, make sure to download the training and test data. The downloads are usually handled by the "fedn run startup" command. + .. code-block:: bash fedn run train --path client --input --output - fedn run validate --path client --input --output + fedn run validate --path client --input --output Packaging for training on FEDn =============================== From 3008ed8ab1025344c0ee9d70e821489ca90f9763 Mon Sep 17 00:00:00 2001 From: Fredrik Wrede Date: Fri, 6 Sep 2024 14:42:00 +0200 Subject: [PATCH 5/5] Update projects.rst --- docs/projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/projects.rst b/docs/projects.rst index 498e11d37..ff4c6e735 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -387,7 +387,7 @@ Then, standing inside the 'client folder', you can test *train* and *validate* b You can also test *train* and *validate* entrypoint using CLI command: -.. note:: Before running the fedn run train or fedn run validate commands, make sure to download the training and test data. The downloads are usually handled by the "fedn run startup" command. +.. note:: Before running the fedn run train or fedn run validate commands, make sure to download the training and test data. The downloads are usually handled by the "fedn run startup" command in the examples provided by FEDn. .. code-block:: bash