NVIDIA FLARE Logo

Overview

  • Welcome to NVIDIA FLARE
  • NVIDIA FLARE Roadmap
  • What’s New in FLARE v2.8.0
  • Industry Use Cases

Get Started

  • Installation
  • Quick Start Series
  • Migration Guide

User Guide

  • Client API Usage
  • NVFlare Job Recipe
  • Available Recipes
  • FLARE API
  • API Evolution & Recommendations
  • Running Flower in NVIDIA FLARE
  • Experiment Tracking
  • Federated XGBoost
  • Data Preparation & Heterogeneity
  • CLI Tools

Examples & Tutorials

  • Example Applications
  • Tutorials
  • Self-Paced-Training Tutorials
  • Research Papers

Large Models & LLM

  • Federated LLM Fine-Tuning
  • Message Quantization
  • Memory Management
  • FLARE Tensor Downloader
  • FLARE File Streaming
  • Decomposer for Large Objects

Edge & Mobile

  • Mobile Training (iOS / Android)
  • Mobile SDK Reference
  • Hierarchical FL
  • Hierarchical Communication and Clients

Deployment & Operations

  • Deployment Overview
  • Provisioning in NVIDIA FLARE
  • Distributed Provisioning
  • NVFLARE Dashboard UI
  • Cloud Deployment
  • Deploy Prepare
  • Running FLARE in Docker
  • Running FLARE in Kubernetes
  • Brev Scripted Deployment Quickstart
  • Brev Kubernetes Helm Deployment
  • Preflight Check
  • Operating NVFLARE - Admin Client, Commands, FLARE API
  • Monitoring
  • Logging Configuration
  • Live Log Streaming
  • Site Configuration Metadata
  • System Configuration

Security & Compliance

  • NVIDIA FLARE Security Overview
  • Terminologies and Roles
  • Identity & Access Control
  • Site Policy Management
  • Network & Communication
  • Data Privacy & Filters
  • Differential Privacy
  • Auditing
  • Confidential Computing
  • Security FAQ

Developer Guide

  • Architecture & Developer Guide

Reference

  • API Reference
  • Glossary
  • Publications and Talks
  • Previous Releases of FLARE
  • Contributing
NVIDIA FLARE
  • nvflare
  • nvflare package
  • nvflare.utils package
  • View page source

nvflare.utils package

Submodules

  • nvflare.utils.cli_utils module
    • append_if_not_in_list()
    • backup_hidden_config_file()
    • check_dir()
    • create_job_template_config()
    • create_poc_workspace_config()
    • find_in_list()
    • find_job_templates_location()
    • find_startup_kit_config_keys()
    • get_curr_dir()
    • get_hidden_config()
    • get_hidden_nvflare_config_path()
    • get_hidden_nvflare_dir()
    • get_home_dir()
    • get_or_create_hidden_nvflare_dir()
    • get_package_root()
    • hocon_to_string()
    • is_dir_empty()
    • load_config()
    • load_hidden_config()
    • load_hidden_config_state()
    • print_hidden_config()
    • remove_startup_kit_config_keys()
    • save_config()
    • save_configs()
  • nvflare.utils.configs module
    • get_client_config_value()
    • get_job_config_value()
    • get_server_config_value()
  • nvflare.utils.decorators module
    • collect_time()
    • measure_time()
  • nvflare.utils.job_launcher_utils module
    • add_custom_dir_to_path()
    • generate_client_command()
    • generate_server_command()
    • get_client_job_args()
    • get_job_launcher_spec()
    • get_launcher_resource_spec()
    • get_server_job_args()
    • get_site_launcher_spec()
    • refresh_custom_dir_import_path()
  • nvflare.utils.process_utils module
    • ProcessAdapter
      • ProcessAdapter.poll()
      • ProcessAdapter.terminate()
      • ProcessAdapter.wait()
    • spawn_process()
  • nvflare.utils.zip_utils module
    • print_tree()
    • print_zip_tree()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

Built with Sphinx using a theme provided by Read the Docs.