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.app_common package
  • nvflare.app_common.app_defined package
  • View page source

nvflare.app_common.app_defined package

Submodules

  • nvflare.app_common.app_defined.aggregator module
    • AppDefinedAggregator
      • AppDefinedAggregator.accept()
      • AppDefinedAggregator.aggregate()
      • AppDefinedAggregator.aggregate_training_result()
      • AppDefinedAggregator.handle_event()
      • AppDefinedAggregator.processing_training_result()
      • AppDefinedAggregator.reset()
  • nvflare.app_common.app_defined.component_base module
    • ComponentBase
      • ComponentBase.critical()
      • ComponentBase.debug()
      • ComponentBase.error()
      • ComponentBase.exception()
      • ComponentBase.info()
      • ComponentBase.warning()
  • nvflare.app_common.app_defined.model_persistor module
    • AppDefinedModelPersistor
      • AppDefinedModelPersistor.load_model()
      • AppDefinedModelPersistor.read_model()
      • AppDefinedModelPersistor.save_model()
      • AppDefinedModelPersistor.write_model()
  • nvflare.app_common.app_defined.shareable_generator module
    • AppDefinedShareableGenerator
      • AppDefinedShareableGenerator.learnable_to_shareable()
      • AppDefinedShareableGenerator.model_to_trainable()
      • AppDefinedShareableGenerator.shareable_to_learnable()
      • AppDefinedShareableGenerator.update_model()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

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