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.metrics package
  • View page source

nvflare.metrics package

Submodules

  • nvflare.metrics.job_metrics_collector module
    • JobMetricsCollector
      • JobMetricsCollector.get_pair_events()
      • JobMetricsCollector.get_single_events()
      • JobMetricsCollector.handle_event()
      • JobMetricsCollector.publish_metrics()
  • nvflare.metrics.metrics_collector module
    • MetricsCollector
      • MetricsCollector.collect_event_metrics()
      • MetricsCollector.get_pair_events()
      • MetricsCollector.get_single_events()
      • MetricsCollector.publish_metrics()
  • nvflare.metrics.metrics_keys module
    • MetricKeys
      • MetricKeys.count
      • MetricKeys.metric_name
      • MetricKeys.tags
      • MetricKeys.time_taken
      • MetricKeys.timestamp
      • MetricKeys.type
      • MetricKeys.value
    • MetricTypes
      • MetricTypes.COUNTER
      • MetricTypes.GAUGE
      • MetricTypes.HISTOGRAM
      • MetricTypes.SUMMARY
  • nvflare.metrics.metrics_publisher module
    • collect_metrics()
    • convert_metrics_to_event()
    • publish_app_metrics()
  • nvflare.metrics.remote_metrics_receiver module
    • RemoteMetricsReceiver
      • RemoteMetricsReceiver.handle_event()
  • nvflare.metrics.system_metrics_collector module
    • SysMetricsCollector
      • SysMetricsCollector.get_pair_events()
      • SysMetricsCollector.get_single_events()
      • SysMetricsCollector.handle_event()

Module contents

Previous Next

© Copyright 2025 NVIDIA.

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