Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
chesterxgchen committed Jan 7, 2025
1 parent efddb77 commit 011f313
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
6 changes: 4 additions & 2 deletions examples/advanced/monitoring/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# NVFLARE Metrics Monitoring Setup
# NVFLARE System Metrics Monitoring

This guide describes how to set up NVFLARE metrics publishing to StatsD Exporter, which then can be scraped by Prometheus and visualized with Grafana.
FLARE Monitoring provides a initial solution for tracking system metrics of your federated learning jobs.
Different from Machine learning experiment tracking, where it focused on the training metrics, the monitoring here focused on the FL system: i.e. job and system lifecycle metrics.

This guide describes how to set up NVFLARE metrics publishing to StatsD Exporter, which then can be scraped by Prometheus and visualized with Grafana.

## Setup Types

Expand Down
5 changes: 4 additions & 1 deletion examples/advanced/monitoring/jobs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# FLARE Monitoring
FLARE Monitoring provides a comprehensive solution for tracking and analyzing the performance of your federated learning jobs. This guide will walk you through the steps to set up and use the monitoring system effectively.
FLARE Monitoring provides a initial solution for tracking system metrics of your federated learning jobs.
Different from Machine learning experiment tracking, where it focused on the training metrics, the monitoring here focused on the FL system: i.e. job and system lifecycle metrics.

This guide will walk you through the steps to set up and use the monitoring system effectively.
Please see [hello-pytorch](../../../../hello-world/hello-pt/README.md) for details on how to run hello-pt.

## Prepare Code
Expand Down

0 comments on commit 011f313

Please sign in to comment.