Update hello-numpy-sag from app to job structure and update docs (NVI…

…DIA#430)
pxLi · Apr 22, 2022 · cdaef9d · cdaef9d
1 parent 48daa2a
commit cdaef9d
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 29 deletions.
diff --git a/docs/examples/hello_numpy.rst b/docs/examples/hello_numpy.rst
@@ -130,31 +130,11 @@ each command.
 
 .. code-block:: shell
 
-    > upload_app hello-numpy-sag
+    > upload_job hello-numpy-sag
 
-Uploads the application from the admin client to the server's staging area.
+Uploads the job configuration from the admin client to the server.
+A job id will be returned, and we can use that id to access job information.
 
-.. code-block:: shell
-
-    > set_run_number 1
-
-Creates a run directory in the workspace for the run_number on the server and all clients. The run directory allows for
-the isolation of different runs so the information in one particular run does not interfere with other runs.
-
-.. code-block:: shell
-
-    > deploy_app hello-numpy-sag all
-
-This will make the hello-numpy-sag application the active one in the run_number workspace.  After the above two commands, the
-server and all the clients know the hello-numpy-sag application will reside in the ``run_1`` workspace.
-
-
-.. code-block:: shell
-
-    > start_app all
-
-This ``start_app`` command instructs the NVIDIA FLARE server and clients to start training with the hello-numpy-sag
-application in the ``run_1`` workspace.
 
 From time to time, you can issue ``check_status server`` in the admin client to check the entire training progress.
 

diff --git a/examples/hello-numpy-sag/README.md b/examples/hello-numpy-sag/README.md
@@ -19,10 +19,7 @@ Log into the Admin client by entering `admin` for both the username and password
 Then, use these Admin commands to run the experiment:
 
 ```
-set_run_number 1
-upload_app hello-numpy-sag
-deploy_app hello-numpy-sag all
-start_app all
+upload_job hello-numpy-sag
 ```
 
 ### 4. Shut down the server/clients

diff --git a/...o-numpy-sag/config/config_fed_client.json → ...o-numpy-sag/config/config_fed_client.json b/...o-numpy-sag/config/config_fed_client.json → ...o-numpy-sag/config/config_fed_client.json
diff --git a/...o-numpy-sag/config/config_fed_server.json → ...o-numpy-sag/config/config_fed_server.json b/...o-numpy-sag/config/config_fed_server.json → ...o-numpy-sag/config/config_fed_server.json
diff --git a/examples/hello-numpy-sag/custom/__init__.py → ...py-sag/hello-numpy-sag/custom/__init__.py b/examples/hello-numpy-sag/custom/__init__.py → ...py-sag/hello-numpy-sag/custom/__init__.py
diff --git a/examples/hello-numpy-sag/custom/constants.py → ...y-sag/hello-numpy-sag/custom/constants.py b/examples/hello-numpy-sag/custom/constants.py → ...y-sag/hello-numpy-sag/custom/constants.py
diff --git a/...lo-numpy-sag/custom/np_model_persistor.py → ...lo-numpy-sag/custom/np_model_persistor.py b/...lo-numpy-sag/custom/np_model_persistor.py → ...lo-numpy-sag/custom/np_model_persistor.py
diff --git a/...ples/hello-numpy-sag/custom/np_trainer.py → ...-sag/hello-numpy-sag/custom/np_trainer.py b/...ples/hello-numpy-sag/custom/np_trainer.py → ...-sag/hello-numpy-sag/custom/np_trainer.py
diff --git a/examples/hello-numpy-sag/meta.json b/examples/hello-numpy-sag/meta.json
@@ -0,0 +1,8 @@
+{
+  "study_name": "demo-study",
+  "name": "hello-numpy-sag",
+  "resource_spec": {"site-1": {}, "site-2": {}},
+  "deploy_map": {
+    "hello-numpy-sag": ["server", "site-1", "site-2"]
+  }
+}
diff --git a/nvflare/lighter/project.yml b/nvflare/lighter/project.yml
@@ -25,11 +25,11 @@ participants:
     admin_port: 8003
     # enable_byoc loads python codes in app.  Default is false.
     enable_byoc: true
-  - name: site1
+  - name: site-1
     type: client
     org: nvidia
     enable_byoc: true
-  - name: site2
+  - name: site-2
     type: client
     org: nvidia
     enable_byoc: false