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
  • Deploying FLARE on OpenShift
  • 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.apis package
  • nvflare.apis.utils package
  • View page source

nvflare.apis.utils package

Subpackages

  • nvflare.apis.utils.decomposers package
    • Submodules
      • nvflare.apis.utils.decomposers.flare_decomposers module
        • ContextDecomposer
        • DXODecomposer
        • WorkspaceDecomposer
        • register()
    • Module contents

Submodules

  • nvflare.apis.utils.analytix_utils module
    • create_analytic_dxo()
    • send_analytic_dxo()
  • nvflare.apis.utils.event module
    • fire_event_to_components()
  • nvflare.apis.utils.fl_context_utils module
    • add_job_audit_event()
    • gen_new_peer_ctx()
    • generate_log_message()
    • get_client()
    • get_serializable_data()
  • nvflare.apis.utils.format_check module
    • check_job_app_name()
    • check_job_id()
    • name_check()
    • validate_args()
    • validate_class_methods_args()
  • nvflare.apis.utils.job_submit_token module
    • canonical_job_content_hash()
    • canonical_json_hash()
    • submit_record_scope_hashes()
    • submitter_to_dict()
    • validate_submit_token()
  • nvflare.apis.utils.job_utils module
    • convert_legacy_zipped_app_to_job()
    • load_job_def_bytes()
  • nvflare.apis.utils.reliable_message module
    • ReliableMessage
      • ReliableMessage.debug()
      • ReliableMessage.enable()
      • ReliableMessage.error()
      • ReliableMessage.info()
      • ReliableMessage.is_available()
      • ReliableMessage.register_request_handler()
      • ReliableMessage.release_request_receiver()
      • ReliableMessage.send_request()
      • ReliableMessage.shutdown()
      • ReliableMessage.warning()
  • nvflare.apis.utils.task_utils module
    • apply_filters()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

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