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

Add Katib metric strategies info #2316

Merged

Conversation

andreyvelich
Copy link
Member

Fixes: kubeflow/katib#1310.
Blocked by: #2312.

I added doc about metricStrategies in Objective section.

/assign @johnugeorge @gaocegege

/cc @8bitmp3

@kubeflow-bot
Copy link

This change is Reviewable

@andreyvelich andreyvelich force-pushed the issue-1310-metrics-strategies-info branch from 6927b20 to 4055a54 Compare November 11, 2020 13:24
@k8s-ci-robot
Copy link
Contributor

[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

@andreyvelich andreyvelich changed the title [WIP] Add Katib metric strategies info Add Katib metric strategies info Nov 11, 2020
@andreyvelich
Copy link
Member Author

This PR is ready.
/cc @gaocegege @8bitmp3 @johnugeorge

@@ -64,14 +64,45 @@ These are the fields in the experiment configuration spec:
how the hyperparameters work with the model.
Katib records the value of the best `objectiveMetricName` metric (maximized
or minimized based on `type`) and the corresponding hyperparameter set
in Experiment's `.status.currentOptimalTrial.parameterAssignments`.
in experiment's `.status.currentOptimalTrial.parameterAssignments`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
in experiment's `.status.currentOptimalTrial.parameterAssignments`.
in the experiment's `.status.currentOptimalTrial.parameterAssignments`.

- When the objective `type` is `minimize`, Katib compares all minimum
metric values.

You are able to change the default mechanism. For that, define
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You are able to change the default mechanism. For that, define
To change the default settings, define

`additionalMetricNames`. The experiment's objective value is calculated in
accordance with the selected strategy.

For example, if you set the below parameters in your experiment:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example, if you set the below parameters in your experiment:
For example, you can set the parameters in your experiment as follows:

. . .
```

Katib controller is searching for the best maximum from the all latest
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Katib controller is searching for the best maximum from the all latest
where the Katib controller is searching for the best maximum from the all latest

Copy link
Contributor

@8bitmp3 8bitmp3 left a comment

Choose a reason for hiding this comment

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

PTAL 👍

Copy link
Member Author

@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 the review @8bitmp3.
I made changes.

Copy link
Member

@gaocegege gaocegege left a comment

Choose a reason for hiding this comment

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

LGTM 👍
/lgtm

@k8s-ci-robot k8s-ci-robot merged commit 14a9943 into kubeflow:master Nov 13, 2020
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.

[Documentation] Metrics strategies information
6 participants