Skip to content

Commit eb12552

Browse files
Fix job templates (#3311)
After #3088 #3115 our params_exchange_format meaning changed a bit. right now it means the exchange format between client script and NVFlare system. ### Description Update the job_templates accordingly and add a migration doc ### Types of changes <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [x] Non-breaking change (fix or new feature that would not break existing functionality). - [ ] Breaking change (fix or new feature that would cause existing functionality to change). - [ ] New tests added to cover the changes. - [ ] Quick tests passed locally by running `./runtest.sh`. - [ ] In-line docstrings updated. - [ ] Documentation updated. --------- Co-authored-by: Chester Chen <[email protected]>
1 parent b738686 commit eb12552

File tree

15 files changed

+36
-14
lines changed

15 files changed

+36
-14
lines changed

docs/release_notes/flare_260.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**************************
2+
What's New in FLARE v2.6.0
3+
**************************
4+
5+
6+
**********************************
7+
Migration to 2.6.0: Notes and Tips
8+
**********************************
9+
10+
11+
For PTClientAPILauncherExecutor and PTInProcessClientAPIExecutor
12+
FLARE 2.6.0 introduces significant changes to the "params_exchange_format" argument in PTClientAPILauncherExecutor and PTInProcessClientAPIExecutor. These changes impact how data is exchanged between the client script and NVFlare.
13+
14+
### Changes in params_exchange_format
15+
In previous versions, setting "params_exchange_format" to "pytorch" indicated that the client was using a PyTorch tensor on the third-party side. In this case, the tensor would be converted to a NumPy array before being sent back to NVFlare.
16+
17+
With the improvements introduced in FLARE 2.6.0, which now natively support PyTorch tensors during transmission, the meaning of "params_exchange_format" = "pytorch" has changed. Now, this setting directly sends PyTorch tensors to NVFlare without converting them to NumPy arrays.
18+
19+
### Action Required
20+
To maintain the previous behavior (where PyTorch tensors are converted to NumPy arrays), you will need to explicitly set "params_exchange_format" to "numpy".
21+

docs/whats_new.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
What's New
55
##########
66

7-
.. include:: release_notes/flare_250.rst
7+
.. include:: release_notes/flare_260.rst
88

99
**************************
1010
Previous Releases of FLARE
@@ -13,6 +13,7 @@ Previous Releases of FLARE
1313
.. toctree::
1414
:maxdepth: 1
1515

16+
release_notes/flare_250
1617
release_notes/flare_240
1718
release_notes/flare_230
1819
release_notes/flare_220

job_templates/cyclic_cc_pt/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
heartbeat_timeout = 60
3838

3939
# format of the exchange parameters
40-
params_exchange_format = "pytorch"
40+
params_exchange_format = "numpy"
4141

4242
# if the transfer_type is FULL, then it will be sent directly
4343
# if the transfer_type is DIFF, then we will calculate the

job_templates/cyclic_pt/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_cse_ccwf_pt/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
heartbeat_timeout = 60
4242

4343
# format of the exchange parameters
44-
params_exchange_format = "pytorch"
44+
params_exchange_format = "numpy"
4545

4646
# if the transfer_type is FULL, then it will be sent directly
4747
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_gnn/app_1/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_gnn/app_2/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_nemo/app_1/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
heartbeat_timeout = 60
3636

3737
# format of the exchange parameters
38-
params_exchange_format = "pytorch"
38+
params_exchange_format = "numpy"
3939

4040
# if the transfer_type is FULL, then it will be sent directly
4141
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_nemo/app_2/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
heartbeat_timeout = 60
3636

3737
# format of the exchange parameters
38-
params_exchange_format = "pytorch"
38+
params_exchange_format = "numpy"
3939

4040
# if the transfer_type is FULL, then it will be sent directly
4141
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_nemo/app_3/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
heartbeat_timeout = 60
3636

3737
# format of the exchange parameters
38-
params_exchange_format = "pytorch"
38+
params_exchange_format = "numpy"
3939

4040
# if the transfer_type is FULL, then it will be sent directly
4141
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_pt/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_pt_deploy_map/app_1/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_pt_deploy_map/app_2/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_pt_he/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

job_templates/sag_pt_mlflow/config_fed_client.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
heartbeat_timeout = 60
3333

3434
# format of the exchange parameters
35-
params_exchange_format = "pytorch"
35+
params_exchange_format = "numpy"
3636

3737
# if the transfer_type is FULL, then it will be sent directly
3838
# if the transfer_type is DIFF, then we will calculate the

0 commit comments

Comments
 (0)