diff --git a/examples/advanced/monitoring/README.md b/examples/advanced/monitoring/README.md index 88716a0574..99eee0d84a 100644 --- a/examples/advanced/monitoring/README.md +++ b/examples/advanced/monitoring/README.md @@ -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 diff --git a/examples/advanced/monitoring/jobs/README.md b/examples/advanced/monitoring/jobs/README.md index de4b899030..f6bbd30b70 100644 --- a/examples/advanced/monitoring/jobs/README.md +++ b/examples/advanced/monitoring/jobs/README.md @@ -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