fx plan command#
fx plan#
Manage Federated Learning Plans.
fx plan [OPTIONS] COMMAND [ARGS]...
freeze#
Finalize the Data Science plan.
Create a new plan file that embeds its hash in the file name (plan.yaml -> plan_{hash}.yaml) and changes the permissions to read only.
- Args:
plan_config (str): Federated learning plan.
fx plan freeze [OPTIONS]
Options
- -p, --plan_config <plan_config>#
Path to an FL plan.
- Default:
'plan/plan.yaml'
initialize#
Initializes a Data Science plan and generates a protobuf file of the initial model weights for the federation.
fx plan initialize [OPTIONS]
Options
- -p, --plan_config <plan_config>#
Path to an FL plan.
- Default:
'plan/plan.yaml'
- -c, --cols_config <cols_config>#
Path to an authorized collaborator list.
- Default:
'plan/cols.yaml'
- -d, --data_config <data_config>#
The dataset shard configuration file.
- Default:
'plan/data.yaml'
- -a, --aggregator_address <aggregator_address>#
The FQDN of the federation aggregator
- -f, --input_shape <input_shape>#
The input spec of the model.
May be provided as a list for single input head:
--input-shape [3,32,32],or as a dictionary for multihead models (must be passed in quotes):
--input-shape "{'input_0': [1, 240, 240, 4],'input_1': [1, 240, 240, 1]}".
- -g, --gandlf_config <gandlf_config>#
GaNDLF Configuration File Path
- -i, --init_model_path <init_model_path>#
Path to initial model protobuf file.
remove#
Removes given plan.
fx plan remove [OPTIONS]
Options
- -n, --name <name>#
Name of the FL plan to remove.
- Default:
'default'
save#
Saves the given plan and switches to it.
fx plan save [OPTIONS]
Options
- -n, --name <name>#
Name of the FL plan.
show#
Shows the active plan.
fx plan show [OPTIONS]
switch#
Switch the current plan to this plan.
fx plan switch [OPTIONS]
Options
- -n, --name <name>#
Name of the FL plan to switch to.