Skip to content

fix(blog): add workflow & doc & example in push-based metrics collection blog. #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
google-oss-prow merged 2 commits into from
Mar 3, 2025
+5 −1
Merged

fix(blog): add workflow & doc & example in push-based metrics collection blog. #162

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d666ff6
fix: add workflow & doc & example.
Electronic-Waste Mar 2, 2025
7adab08
fix: add tune func description.
Electronic-Waste Mar 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion _posts/2024-09-28-gsoc-2024-summary-push-basd-metrics-collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The current implementation of Metrics Collector is pull-based, raising design pr

We decided to implement a new API for Katib Python SDK to offer users a push-based way to store metrics directly into the Kaitb DB and resolve those issues raised by pull-based metrics collection.

In the new design, users just need to set `metrics_collector_config={"kind": "Push"}` in the `tune()` function and call the `report_metrics()` API in their objective function to push metrics to Katib DB directly. There are no sidecar containers and restricted metric log formats any more. After that, Trial Controller will continuously collect metrics from Katib DB and update the status of Trial, which is the same as pull-based metrics collection.

If you are interested in it, please refer to this [doc](https://www.kubeflow.org/docs/components/katib/user-guides/metrics-collector/#push-based-metrics-collector) and [example](https://github.com/kubeflow/katib/blob/master/examples/v1beta1/sdk/mnist-with-push-metrics-collection.ipynb) for more details.

![](../images/2024-09-28-gsoc-2024-summary-push-based-metrics-collection/push-based-metrics-collection.png)

## My Contributions during the GSoC
Expand All @@ -40,7 +44,7 @@ For reference, the coding period can be rougly divided into 3 stages:

Also, I raised some issues not only to describe the problems and bugs I met during the coding period, but also to suggest the future enhancement direction for Katib and the Training-Operator.

There is an [Github Issue](https://github.com/kubeflow/katib/issues/2340) tracks the progress of developing push-based metrics collection for katib during the GSoC coding phase. If you are interested in my work or Katib, please can check this issue for more details.
There is a [Github Issue](https://github.com/kubeflow/katib/issues/2340) tracks the progress of developing push-based metrics collection for katib during the GSoC coding phase. If you are interested in my work or Katib, please can check this issue for more details.

## Lessons Learned

Expand Down