nvflare.tool.poc.poc_commands module

add_docker_builder(use_docker: bool, project_config: OrderedDict)[source]
add_he_builder(use_he: bool, project_config: OrderedDict)[source]
add_legacy_options(parser)[source]
async_process(service_name, cmd_path, gpu_ids: List[int] | None, service_config: Dict)[source]
clean_poc(cmd_args)[source]
client_gpu_assignments(clients: List[str], gpu_ids: List[int]) → Dict[str, List[int]][source]
def_poc_parser(sub_cmd)[source]
define_clean_parser(poc_parser)[source]
define_prepare_jobs_parser(poc_parser)[source]
define_prepare_parser(poc_parser, cmd: str | None = None, help_str: str | None = None)[source]
define_start_parser(poc_parser)[source]
define_stop_parser(poc_parser)[source]
gen_project_config_file(workspace: str) → str[source]
get_cmd_path(poc_workspace, service_name, cmd)[source]
get_examples_dir(examples_dir)[source]
get_excluded(cmd_args)[source]
get_fl_admins(project_config: OrderedDict, is_project_admin: bool)[source]
get_fl_client_names(project_config: OrderedDict) → List[str][source]
get_fl_server_name(project_config: OrderedDict) → str[source]
get_gpis(cmd_args)[source]
get_gpu_ids(user_input_gpu_ids, host_gpu_ids) → List[int][source]
get_local_host_gpu_ids()[source]
get_nvflare_home() → str | None[source]
get_or_create_hidden_nvflare_config_path() → str[source]

Get the path for the hidden nvflare configuration file.

Returns:

The path to the hidden nvflare configuration file.

Return type:

str

get_other_admins(project_config: OrderedDict)[source]
get_poc_workspace()[source]
get_prod_dir(workspace, project_name: str = 'example_project')[source]
get_proj_admin(project_config: OrderedDict)[source]
get_project_hosts(project_config) → List[str][source]
get_service_command(cmd_type: str, prod_dir: str, service_dir, service_config: Dict) → str[source]
get_service_config(project_config)[source]
get_service_list(cmd_args)[source]
get_stop_cmd(poc_workspace: str, service_dir_name: str)[source]
get_upload_dir(startup_dir) → str[source]
handle_poc_cmd(cmd_args)[source]
is_dir_empty(path: str)[source]
is_docker_run(project_config: OrderedDict)[source]
is_poc_ready(poc_workspace: str, service_config, project_config)[source]
is_poc_running(poc_workspace, service_config, project_config)[source]
local_provision(clients: List[str], number_of_clients: int, workspace: str, docker_image: str, use_he: bool = False, project_conf_path: str = '') → Tuple[source]
old_clean_poc()[source]
old_prepare_poc()[source]
old_start_poc()[source]
old_stop_poc()[source]
prepare_builders(project_dict: OrderedDict) → List[source]
prepare_clients(clients, number_of_clients)[source]
prepare_env(service_name, gpu_ids: List[int] | None, service_config: Dict)[source]
prepare_jobs_dir(cmd_args)[source]
prepare_poc(cmd_args)[source]
prepare_poc_provision(clients: List[str], number_of_clients: int, workspace: str, docker_image: str, use_he: bool = False, project_conf_path: str = '', examples_dir: str | None = None) → Dict[source]
replace_server_with_localhost(sp_end_point: str) → str[source]
Parameters:

example (sp_end_point:(str)) – server1:8002:8003

Returns:

localhost:<port1>:<port2>

save_project_config(project_config, project_file)[source]
save_startup_kit_dir_config(workspace, project_name)[source]
setup_service_config(poc_workspace) → Tuple[source]
start_poc(cmd_args)[source]
stop_poc(cmd_args)[source]
sync_process(service_name, cmd_path)[source]
update_clients(clients: List[str], n_clients: int, project_config: OrderedDict) → OrderedDict[source]
update_server_name(project_config)[source]
update_static_file_builder(docker_image: str, project_config: OrderedDict)[source]
validate_gpu_ids(gpu_ids: list, host_gpu_ids: list)[source]
validate_participants(participant_names, list_participants)[source]
validate_poc_workspace(poc_workspace: str, service_config, project_config=None)[source]
validate_services(project_config, services_list: List, excluded: List)[source]
verify_host(host_name: str) → bool[source]
verify_hosts(project_config: OrderedDict)[source]