nvflare.tool package

Subpackages

• nvflare.tool.cert package
  • Submodules
    • nvflare.tool.cert.cert_cli module
      • def_cert_cli_parser()
      • handle_cert_cmd()
    • nvflare.tool.cert.cert_commands module
      • generate_csr_files()
      • handle_cert_approve()
      • handle_cert_csr()
      • handle_cert_init()
      • handle_cert_request()
      • handle_cert_sign()
      • sign_csr_files()
    • nvflare.tool.cert.cert_constants module
      • is_valid_provision_version()
    • nvflare.tool.cert.file_utils module
      • read_file_nofollow()
      • safe_project_name_error()
      • write_file_nofollow()
    • nvflare.tool.cert.fingerprint module
      • cert_fingerprint_sha256()
      • normalize_sha256_fingerprint()
  • Module contents
• nvflare.tool.deploy package
  • Submodules
    • nvflare.tool.deploy.deploy_cli module
      • def_deploy_cli_parser()
      • handle_deploy_cmd()
    • nvflare.tool.deploy.deploy_commands module
      • KitInfo
      • prepare_deployment()
  • Module contents
• 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()
      • cmd_job_abort()
      • cmd_job_clone()
      • cmd_job_delete()
      • cmd_job_download()
      • cmd_job_list()
      • cmd_job_log()
      • cmd_job_logs()
      • cmd_job_meta()
      • cmd_job_monitor()
      • cmd_job_stats()
      • cmd_job_wait()
      • convert_args_list_to_dict()
      • create_app_dir()
      • create_job()
      • def_job_cli_parser()
      • define_abort_job_parser()
      • define_clone_job_parser()
      • define_create_job_parser()
      • define_delete_job_parser()
      • define_download_job_parser()
      • define_job_log_parser()
      • define_job_logs_parser()
      • define_job_meta_parser()
      • define_job_monitor_parser()
      • define_job_stats_parser()
      • define_job_wait_parser()
      • define_list_jobs_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_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.kit package
  • Submodules
    • nvflare.tool.kit.kit_cli module
      • cmd_kit_add()
      • cmd_kit_inspect()
      • cmd_kit_list()
      • cmd_kit_remove()
      • cmd_kit_use()
      • def_kit_cli_parser()
      • default_startup_kit_id()
      • handle_kit_cmd()
    • nvflare.tool.kit.kit_config module
      • StartupKitConfigError
      • add_startup_kit_entry()
      • classify_startup_kit()
      • clear_active_if()
      • get_active_startup_kit_id()
      • get_cli_config_path()
      • get_startup_kit_entries()
      • get_startup_kit_status()
      • inspect_startup_kit_metadata()
      • load_cli_config()
      • remove_entries_under_workspace()
      • remove_startup_kit_entry()
      • resolve_admin_user_and_dir_from_startup_kit()
      • resolve_startup_kit_dir()
      • resolve_startup_kit_dir_by_id()
      • save_cli_config()
      • set_active_startup_kit()
      • validate_admin_startup_kit()
      • validate_startup_kit()
  • Module contents
• nvflare.tool.package package
  • Submodules
    • nvflare.tool.package.package_cli module
      • def_package_cli_parser()
      • handle_package_cmd()
    • nvflare.tool.package.package_commands module
      • FixedProdWorkspaceBuilder
      • PrebuiltCertBuilder
      • handle_package()
  • Module contents
• nvflare.tool.package_checker package
  • Submodules
    • nvflare.tool.package_checker.check_rule module
      • CheckAddressBinding
      • CheckResult
      • CheckRule
      • CheckServerAvailable
      • CheckWriting
    • nvflare.tool.package_checker.client_package_checker module
      • ClientPackageChecker
    • nvflare.tool.package_checker.nvflare_console_package_checker module
      • NVFlareConsolePackageChecker
    • nvflare.tool.package_checker.package_checker module
      • CheckStatus
      • PackageChecker
    • nvflare.tool.package_checker.server_package_checker module
      • ServerPackageChecker
    • nvflare.tool.package_checker.utils module
      • NVFlareConfig
      • NVFlareRole
      • check_grpc_server_running()
      • check_socket_server_running()
      • get_communication_scheme()
      • 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_he_builder()
      • add_poc_docker_runtime()
      • add_poc_site()
      • add_poc_user()
      • async_process()
      • clean_poc()
      • client_gpu_assignments()
      • config_poc()
      • def_poc_parser()
      • define_add_site_parser()
      • define_add_user_parser()
      • define_clean_parser()
      • define_config_parser()
      • define_prepare_parser()
      • define_start_parser()
      • define_stop_parser()
      • gen_project_config_file()
      • get_cmd_path()
      • get_docker_run_mode()
      • 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_other_admins()
      • get_poc_docker_runtime_config()
      • 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()
      • prepare_clients()
      • prepare_env()
      • prepare_poc()
      • prepare_poc_provision()
      • save_project_config()
      • save_startup_kit_dir_config()
      • setup_service_config()
      • start_poc()
      • stop_poc()
      • sync_process()
      • update_clients()
      • update_server_name()
      • validate_gpu_ids()
      • validate_participants()
      • validate_poc_workspace()
      • validate_services()
      • verify_host()
      • verify_hosts()
    • nvflare.tool.poc.service_constants module
      • FlareServiceConstants
  • Module contents
• nvflare.tool.recipe package
  • Submodules
    • nvflare.tool.recipe.recipe_cli module
      • cmd_recipe_list()
      • cmd_recipe_show()
      • def_recipe_parser()
      • handle_recipe_cmd()
  • Module contents
• nvflare.tool.study package
  • Submodules
    • nvflare.tool.study.study_cli module
      • cmd_add_site()
      • cmd_add_user()
      • cmd_list()
      • cmd_register()
      • cmd_remove()
      • cmd_remove_site()
      • cmd_remove_user()
      • cmd_show()
      • def_study_cli_parser()
      • handle_study_cmd()
  • Module contents
• nvflare.tool.system package
  • Submodules
    • nvflare.tool.system.system_cli module
      • cmd_system_disable_client()
      • cmd_system_enable_client()
      • cmd_system_log()
      • cmd_system_resources()
      • cmd_system_restart()
      • cmd_system_shutdown()
      • cmd_system_status()
      • cmd_system_version()
      • def_system_cli_parser()
      • handle_system_cmd()
  • Module contents

Submodules

• nvflare.tool.api_utils module
  • SystemStartTimeout
  • abort_jobs()
  • get_running_job_ids()
  • shutdown_system()
  • shutdown_system_by_session()
  • wait_for_system_start()
• nvflare.tool.cli_arg_utils module
  • get_arg_value()
• nvflare.tool.cli_contract module
• nvflare.tool.cli_errors module
  • get_error()
  • get_error_entry()
• nvflare.tool.cli_output module
  • Stream contract for all nvflare CLI command handlers
  • get_connect_timeout()
  • is_json_mode()
  • is_jsonl_mode()
  • output()
  • output_error()
  • output_error_message()
  • output_jsonl_event()
  • output_ok()
  • output_usage_error()
  • print_human()
  • prompt_yn()
  • set_connect_timeout()
  • set_output_format()
• nvflare.tool.cli_schema module
  • handle_schema_flag()
  • parser_to_schema()
• nvflare.tool.cli_session module
  • add_startup_kit_selection_args()
  • new_active_cli_session()
  • new_cli_session()
  • new_cli_session_for_args()
  • resolve_admin_user_and_dir_for_args()
  • resolve_startup_kit_dir_for_args()
  • resolve_startup_kit_info_for_args()
• nvflare.tool.install_skills module
  • install_skills()
• nvflare.tool.preflight_check module
  • check_packages()
  • define_preflight_check_parser()
  • main()
• nvflare.tool.verify_startup_kits module
  • main()

Module contents