Skip to content

Commit 588c661

Browse files
dipannita08copybara-github
authored andcommitted
Update ml-goodput-measurement package for prod PyPi release v0.0.15.
PiperOrigin-RevId: 805568317
1 parent e6ca0ff commit 588c661

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ To release a new version (e.g. from `1.0.0` -> `2.0.0`):
2020
* Update the `[Unreleased]` url: `v1.0.0...HEAD` -> `v2.0.0...HEAD`
2121
2222
-->
23+
## [0.0.15] - 2025-09-09
24+
25+
* Refactor the GoodputMonitor to use multiprocessing instead of multithreading.
26+
* Add more context with structured logging for metric uploads to GCM Monitoring.
27+
2328
## [0.0.14] - 2025-07-29
2429

2530
* Handle non-fatal internal errors, log warnings & continue.
@@ -105,7 +110,8 @@ To release a new version (e.g. from `1.0.0` -> `2.0.0`):
105110
* Initial release of ML Goodput Measurement PyPi package
106111
* Feature: Contains the Goodput module which allows logging and retrieval of training job's overall productive Goodput
107112

108-
[0.0.13]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.13...v0.0.14
113+
[0.0.15]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.14...v0.0.15
114+
[0.0.14]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.13...v0.0.14
109115
[0.0.13]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.12...v0.0.13
110116
[0.0.12]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.11...v0.0.12
111117
[0.0.11]: https://github.com/AI-Hypercomputer/ml-goodput-measurement/compare/v0.0.10...v0.0.11

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -559,11 +559,11 @@ goodput_monitor = monitoring.GoodputMonitor(
559559

560560
### Monitor Cumulative Goodput Metrics
561561

562-
#### Start asynchronous "query and upload" of Goodput
562+
#### Start Asynchronous "Query and Upload" of Goodput
563563

564-
Call the `start_goodput_uploader` API to spin off a thread which continuously
565-
queries and uploads cumulative Goodput metrics to Tensorboard & Google Cloud
566-
Monitoring.
564+
Call the `start_goodput_uploader` API to launch a background process which
565+
continuously queries and uploads cumulative Goodput metrics to Tensorboard
566+
& Google Cloud Monitoring.
567567

568568
> **_NOTE:_** This will upload computed metrics to Google Cloud Monitoring
569569
by default.
@@ -587,7 +587,7 @@ goodput_monitor.start_goodput_uploader()
587587
Call the `stop_goodput_uploader` API to perform a final upload of all metrics
588588
and safely exit.
589589

590-
> **_NOTE:_** This will stop all cumulative metrics upload threads.
590+
> **_NOTE:_** This will stop all cumulative metrics upload processes.
591591
592592
```python
593593
goodput_monitor.stop_goodput_uploader()
@@ -598,7 +598,7 @@ goodput_monitor.stop_goodput_uploader()
598598
#### Start asynchronous "query and upload" of Rolling Window Goodput
599599

600600
Call the `start_rolling_window_goodput_uploader` API to start a background
601-
thread that continuously queries and uploads **rolling window goodput metrics**
601+
process that continuously queries and uploads **rolling window goodput metrics**
602602
to Google Cloud Monitoring.
603603

604604
You must provide a list of window durations in seconds (e.g., `[60, 300, 900]`
@@ -616,9 +616,9 @@ goodput_monitor.start_rolling_window_goodput_uploader(rolling_windows_seconds=[6
616616
#### Stop the Rolling Window Goodput Uploader
617617

618618
Call the `stop_rolling_window_goodput_uploader` API to perform a final upload
619-
of rolling window metrics and safely shut down the background uploader thread.
619+
of rolling window metrics and safely shut down the background uploader process.
620620

621-
> **_NOTE:_** This will stop all rolling window metrics upload threads.
621+
> **_NOTE:_** This will stop all rolling window metrics upload processes.
622622
623623
```python
624624
goodput_monitor.stop_rolling_window_goodput_uploader()

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
[project]
1616
name = "ml_goodput_measurement"
17-
version = "0.0.14"
17+
version = "0.0.15"
1818
authors = [
1919
{ name="Cloud TPU Team", email="[email protected]" },
2020
]

0 commit comments

Comments
 (0)