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.client package
  • nvflare.client.ipc package
  • View page source

nvflare.client.ipc package

Submodules

  • nvflare.client.ipc.defs module
    • AgentClosed
    • CallStateError
    • MetaKey
      • MetaKey.CURRENT_ROUND
      • MetaKey.DATA_KIND
      • MetaKey.FILTER_HISTORY
      • MetaKey.INITIAL_METRICS
      • MetaKey.NUM_STEPS_CURRENT_ROUND
      • MetaKey.PROCESSED_ALGORITHM
      • MetaKey.PROCESSED_KEYS
      • MetaKey.TOTAL_ROUND
    • MsgHeader
      • MsgHeader.RC
      • MsgHeader.TASK_ID
      • MsgHeader.TASK_NAME
    • PayloadKey
      • PayloadKey.DATA
      • PayloadKey.META
    • Task
      • Task.FETCHED
      • Task.NEW
      • Task.PROCESSED
    • TaskResult
    • agent_site_fqcn()
  • nvflare.client.ipc.ipc_agent module
    • IPCAgent
      • IPCAgent.get_task()
      • IPCAgent.start()
      • IPCAgent.stop()
      • IPCAgent.submit_result()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

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