Skip to content

Commit c665e2a

Browse files
fix(blog): add workflow & doc & example in push-based metrics collection blog. (#162)
* fix: add workflow & doc & example. Signed-off-by: Electronic-Waste <[email protected]> * fix: add tune func description. Signed-off-by: Electronic-Waste <[email protected]> --------- Signed-off-by: Electronic-Waste <[email protected]>
1 parent c555c07 commit c665e2a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

_posts/2024-09-28-gsoc-2024-summary-push-basd-metrics-collection.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ The current implementation of Metrics Collector is pull-based, raising design pr
2424

2525
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.
2626

27+
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.
28+
29+
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.
30+
2731
![](../images/2024-09-28-gsoc-2024-summary-push-based-metrics-collection/push-based-metrics-collection.png)
2832

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

4145
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.
4246

43-
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.
47+
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.
4448

4549
## Lessons Learned
4650

0 commit comments

Comments
 (0)