NVIDIA FLARE Logo

Overview

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

Get Started

  • Installation
  • Quick Start Series
  • Migration Guide

User Guide

  • Agent Skills
  • Choose an API Path
  • Client API Usage
  • Collaboration API (Technical Preview)
  • Getting Started with Recipes
  • Recipe API Reference
  • Available Recipes
  • FLARE API
  • 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
  • Running FLARE on Slurm
  • 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.tool package
  • nvflare.tool.agent package
  • View page source

nvflare.tool.agent package

Subpackages

  • nvflare.tool.agent.inspection package
    • Submodules
      • nvflare.tool.agent.inspection.data module
        • inspect_data_target()
      • nvflare.tool.agent.inspection.existing_job module
        • existing_job_state()
      • nvflare.tool.agent.inspection.files module
        • scan_sources()
      • nvflare.tool.agent.inspection.project module
        • LocalImportGraph
        • candidate_scopes()
        • integration()
        • is_secondary()
        • owner_scopes()
      • nvflare.tool.agent.inspection.result module
        • data_result()
        • route_data()
        • route_source()
        • source_result()
      • nvflare.tool.agent.inspection.source module
        • Bindings
        • analyze_tree()
        • ownership()
      • nvflare.tool.agent.inspection.types module
        • FileFacts
        • SourceScan
    • Module contents

Submodules

  • nvflare.tool.agent.agent_cli module
    • def_agent_cli_parser()
    • handle_agent_cmd()
  • nvflare.tool.agent.command_registry module
    • agent_command_registry()
    • agent_commands()
  • nvflare.tool.agent.dataset_inspect module
    • inspect_dataset()
  • nvflare.tool.agent.inspector module
    • inspect_data()
    • inspect_source()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

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