nvflare.tool.job.job_cli module

build_job_template_indices(job_templates_dir: str) → ConfigTree[source]
check_template_exists(target_template_name, template_index_conf)[source]
convert_args_list_to_dict(kvs: List[str] | None = None) → dict[source]

Convert a list of key-value strings to a dictionary.

Parameters:

kvs (Optional[List[str]]) – A list of key-value strings in the format “key=value”.

Returns:

A dictionary containing the key-value pairs from the input list.

Return type:

dict

create_app_dir(job_folder, app_name: str = 'app')[source]
create_job(cmd_args)[source]
def_job_cli_parser(sub_cmd)[source]
define_create_job_parser(job_subparser)[source]
define_list_templates_parser(job_subparser)[source]
define_submit_job_parser(job_subparser)[source]
define_variables_parser(job_subparser)[source]
display_available_templates(template_index_conf)[source]
display_template_variables(job_folder, app_variable_values)[source]
dst_app_path(job_folder: str, app_name='app')[source]
dst_config_path(job_folder, config_filename, app_name: str = 'app')[source]
find_admin_user_and_dir() → Tuple[str, str][source]
find_filename_basename(f: str)[source]
fix_length_format(name: str, name_fix_length: int)[source]
get_app_dirs_from_job_folder(job_folder)[source]
get_app_dirs_from_template(template_dir)[source]
get_config_dir(job_folder: str, app_name: str) → str[source]
get_config_dirs(job_folder: str, app_names: List[str]) → List[str][source]
get_src_template(cmd_args) → str | None[source]
get_src_template_by_name(cmd_args)[source]
get_template_info_config(template_dir)[source]
handle_job_cli_cmd(cmd_args)[source]
has_client_config_file(app_config_dir)[source]
internal_submit_job(admin_user_dir, username, temp_job_dir)[source]
list_templates(cmd_args)[source]
load_default_config_template(config_file_name: str)[source]
prepare_app_dirs(job_folder: str, app_names: List[str]) → List[str][source]
prepare_app_scripts(app_custom_dirs, cmd_args)[source]
prepare_job_config(cmd_args, app_names: List[str], tmp_job_dir: str | None = None)[source]
prepare_job_folder(cmd_args)[source]
prepare_meta_config(cmd_args, target_template_dir, app_names)[source]
remove_extra_files(config_dir)[source]
remove_pycache_files(custom_dir)[source]
save_merged_configs(app_merged_conf, job_folder, tmp_job_dir)[source]
show_variables(cmd_args)[source]
submit_job(cmd_args)[source]
update_job_templates_dir(job_templates_dir: str)[source]