nvflare.tool package

Subpackages

• nvflare.tool.job package
  • Subpackages
    • nvflare.tool.job.config package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.tool.job.job_cli module
      • build_job_template_indices()
      • check_template_exists()
      • convert_args_list_to_dict()
      • create_app_dir()
      • create_job()
      • def_job_cli_parser()
      • define_create_job_parser()
      • define_list_templates_parser()
      • define_submit_job_parser()
      • define_variables_parser()
      • display_available_templates()
      • display_template_variables()
      • dst_app_path()
      • dst_config_path()
      • find_admin_user_and_dir()
      • find_filename_basename()
      • fix_length_format()
      • get_app_dirs_from_job_folder()
      • get_app_dirs_from_template()
      • get_config_dir()
      • get_config_dirs()
      • get_src_template()
      • get_src_template_by_name()
      • get_template_info_config()
      • handle_job_cli_cmd()
      • has_client_config_file()
      • internal_submit_job()
      • is_subdir()
      • list_templates()
      • load_default_config_template()
      • prepare_app_dirs()
      • prepare_app_scripts()
      • prepare_job_config()
      • prepare_job_folder()
      • prepare_meta_config()
      • remove_extra_files()
      • remove_pycache_files()
      • save_merged_configs()
      • show_variables()
      • submit_job()
      • update_job_templates_dir()
    • nvflare.tool.job.job_client_const module
  • Module contents
• nvflare.tool.package_checker package
  • Submodules
    • nvflare.tool.package_checker.check_rule module
      • CheckAddressBinding
      • CheckNonPrimarySPGRPCServerAvailable
      • CheckNonPrimarySPSocketServerAvailable
      • CheckOverseerRunning
      • CheckPrimarySPGRPCServerAvailable
      • CheckPrimarySPSocketServerAvailable
      • CheckResult
      • CheckRule
      • CheckSPListInResponse
      • CheckWriting
    • nvflare.tool.package_checker.client_package_checker module
      • ClientPackageChecker
    • nvflare.tool.package_checker.nvflare_console_package_checker module
      • NVFlareConsolePackageChecker
    • nvflare.tool.package_checker.overseer_package_checker module
      • OverseerPackageChecker
    • nvflare.tool.package_checker.package_checker module
      • PackageChecker
    • nvflare.tool.package_checker.server_package_checker module
      • ServerPackageChecker
    • nvflare.tool.package_checker.utils module
      • NVFlareConfig
      • NVFlareRole
      • check_grpc_server_running()
      • check_overseer_running()
      • check_response()
      • check_socket_server_running()
      • construct_dummy_response()
      • get_required_args_for_overseer_agent()
      • is_dummy_overseer_agent()
      • parse_overseer_agent_args()
      • run_command_in_subprocess()
      • split_by_len()
      • try_bind_address()
      • try_write_dir()
  • Module contents
• nvflare.tool.poc package
  • Submodules
    • nvflare.tool.poc.poc_commands module
      • add_docker_builder()
      • add_he_builder()
      • add_legacy_options()
      • async_process()
      • clean_poc()
      • client_gpu_assignments()
      • def_poc_parser()
      • define_clean_parser()
      • define_prepare_jobs_parser()
      • define_prepare_parser()
      • define_start_parser()
      • define_stop_parser()
      • gen_project_config_file()
      • get_cmd_path()
      • get_examples_dir()
      • get_excluded()
      • get_fl_admins()
      • get_fl_client_names()
      • get_fl_server_name()
      • get_gpis()
      • get_gpu_ids()
      • get_local_host_gpu_ids()
      • get_nvflare_home()
      • get_or_create_hidden_nvflare_config_path()
      • get_other_admins()
      • get_poc_workspace()
      • get_prod_dir()
      • get_proj_admin()
      • get_project_hosts()
      • get_service_command()
      • get_service_config()
      • get_service_list()
      • get_stop_cmd()
      • get_upload_dir()
      • handle_poc_cmd()
      • is_dir_empty()
      • is_docker_run()
      • is_poc_ready()
      • is_poc_running()
      • local_provision()
      • old_clean_poc()
      • old_prepare_poc()
      • old_start_poc()
      • old_stop_poc()
      • prepare_builders()
      • prepare_clients()
      • prepare_env()
      • prepare_jobs_dir()
      • prepare_poc()
      • prepare_poc_provision()
      • replace_server_with_localhost()
      • save_project_config()
      • save_startup_kit_dir_config()
      • setup_service_config()
      • start_poc()
      • stop_poc()
      • sync_process()
      • update_clients()
      • update_server_name()
      • update_static_file_builder()
      • validate_gpu_ids()
      • validate_participants()
      • validate_poc_workspace()
      • validate_services()
      • verify_host()
      • verify_hosts()
    • nvflare.tool.poc.service_constants module
      • FlareServiceConstants
  • Module contents

Submodules

• nvflare.tool.api_utils module
  • abort_jobs()
  • get_running_job_ids()
  • shutdown_system()
  • shutdown_system_by_session()
  • wait_for_system_shutdown()
  • wait_for_system_start()
• nvflare.tool.preflight_check module
  • check_packages()
  • define_preflight_check_parser()
  • main()

Module contents