NVIDIA FLARE
main
  • NVIDIA FLARE Overview
  • What’s New
  • Key Features
  • Getting Started
  • Example Applications
  • Real-World Federated Learning
  • User Guide
  • Programming Best Practices
  • Programming Guide
  • Frequently Asked Questions
  • Publications and Talks
  • Contributing
  • API
    • nvflare package
      • Subpackages
        • nvflare.apis package
        • nvflare.app_common package
        • nvflare.app_opt package
        • nvflare.dashboard package
        • nvflare.fuel package
        • nvflare.ha package
        • nvflare.lighter package
        • nvflare.private package
        • nvflare.security package
        • nvflare.tool package
          • Subpackages
            • nvflare.tool.package_checker package
          • Submodules
            • nvflare.tool.api_utils module
            • nvflare.tool.preflight_check module
          • Module contents
        • nvflare.utils package
        • nvflare.widgets package
      • Submodules
      • Module contents
  • Glossary
NVIDIA FLARE
  • nvflare
  • nvflare package
  • nvflare.tool package
  • Edit on GitHub

nvflare.tool package¶

Subpackages¶

  • 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

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¶

Previous Next

© Copyright 2023, NVIDIA. Revision 7dcabfd9.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: main
Versions
latest
stable
2.3.0
2.3
2.2.1
2.2
2.1.1
2.1.0
2.1
2.0
main
dev-2.1
dev
Downloads
On Read the Docs
Project Home
Builds