Skip to content
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.

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

[GSoC] KEP for Project 6: Push-based Metrics Collection for Katib #2328

Merged

Conversation

Electronic-Waste
Copy link
Member

@Electronic-Waste Electronic-Waste commented May 15, 2024

What this PR does / why we need it:

This PR converts the GSoC Proposal into KEP, which describes the details of implementing "Project 6: Push-based Metrics Collection for Katib". There are some related issues discussing about this :

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Checklist:

  • Docs included if any changes are user facing

Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
@google-oss-prow google-oss-prow bot added size/M and removed size/S labels May 15, 2024
@andreyvelich
Copy link
Member

/area gsoc

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this @Electronic-Waste!
I left a few comments.
/assign @kubeflow/wg-training-leads

docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
@Electronic-Waste
Copy link
Member Author

ref issue: #2340

Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Electronic-Waste!
I think, we almost ready with this proposal, just a few small comments.
Please take a look @tenzen-y @johnugeorge

# The newly added parameter metrics_collector_config.
# It specifies the config of metrics collector, for example,
# metrics_collector_config={"kind": "Push"},
metrics_collector_config: Dict[str, Any] = None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's by default use the StdOut or Push metrics collector, so user doesn't need to configure it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll use StdOut as the default metrics collector since Push metrics collector is under development.

docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
Signed-off-by: Electronic-Waste <2690692950@qq.com>
@Electronic-Waste
Copy link
Member Author

Sincere thanks for your time @andreyvelich . I modified the proposal according to your review.

Could you please review the updated version of the proposal? And We can discuss about it in the meeting today. If there are no extra reviews to make, I can convert the proposal to PRs in this week.

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for these updates @Electronic-Waste!
It looks good.
/lgtm
/assign @tenzen-y @johnugeorge

docs/proposals/push-based-metrics-collection.md Outdated Show resolved Hide resolved
Signed-off-by: Electronic-Waste <2690692950@qq.com>
Signed-off-by: Electronic-Waste <2690692950@qq.com>

### New Parameter in Python SDK Function `tune`

We decided to add `metrics_collection_mechanism` to `tune` function in Python SDK.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be metrics_collector_config right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I forgot to change it. Thank you!

Signed-off-by: Electronic-Waste <2690692950@qq.com>
@johnugeorge
Copy link
Member

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Jun 28, 2024
Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, we can merge this proposal.
We can create followup PRs if we need to modify it.
Thanks again for driving this @Electronic-Waste!
/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit f06906d into kubeflow:master Jun 28, 2024
60 checks passed
shashank-iitbhu pushed a commit to shashank-iitbhu/katib that referenced this pull request Jun 30, 2024
…beflow#2328)

* doc: initial commit of gsoc proposal(project 6).

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* doc: complete KEP for gsoc proposal(Project 6).

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add non-goals and examples.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add .

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add compatibility changes in trial controller.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update architecture figure.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update format.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update doc after the review in 10th, June.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add code link and remove namespace env variable.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: modify proposal after the review in 14th, June.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: delete WIP label.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add timeout param into report_metrics.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* fix: metrics_collector_config spelling.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

---------

Signed-off-by: Electronic-Waste <2690692950@qq.com>
shashank-iitbhu pushed a commit to shashank-iitbhu/katib that referenced this pull request Jul 25, 2024
…beflow#2328)

* doc: initial commit of gsoc proposal(project 6).

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* doc: complete KEP for gsoc proposal(Project 6).

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add non-goals and examples.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add .

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add compatibility changes in trial controller.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update architecture figure.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update format.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: update doc after the review in 10th, June.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add code link and remove namespace env variable.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: modify proposal after the review in 14th, June.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: delete WIP label.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* chore: add timeout param into report_metrics.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

* fix: metrics_collector_config spelling.

Signed-off-by: Electronic-Waste <2690692950@qq.com>

---------

Signed-off-by: Electronic-Waste <2690692950@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants