Skip to content

Implement validation for early stopping #1709

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
merged 9 commits into from
Nov 26, 2021
Merged

Implement validation for early stopping #1709

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3833edc
implement validation for early stopping
tenzen-y Sep 29, 2021
27e84db
fix some documents
tenzen-y Oct 9, 2021
a9322f8
fix error messages
tenzen-y Oct 10, 2021
0e35f07
implement gRPC API to verify parameters for early stopping
tenzen-y Nov 8, 2021
8f6aacd
review: use early_stopping as gRPC API
tenzen-y Nov 9, 2021
17f7abd
review: fix error description
tenzen-y Nov 9, 2021
543ad58
review: remove t.Run
tenzen-y Nov 9, 2021
cae15c6
review: remove condition to verify algorithmName for early stopping
tenzen-y Nov 9, 2021
6f231e8
remove description about updating gRPC API docs in kubeflow website
tenzen-y Nov 11, 2021
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib

## Release Version

For the specific Katib release (for example `v0.11.1`) run this command:
For the specific Katib release (for example `v0.12.0`) run this command:

```
kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=v0.11.1"
kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=v0.12.0"
```

Make sure that all Katib components are running:
Expand Down
4 changes: 0 additions & 4 deletions docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,6 @@ You can find the `cert-generator` source code [here](../cmd/cert-generator/v1bet

Please see [new-algorithm-service.md](./new-algorithm-service.md).

## Algorithm settings documentation

Please see [algorithm-settings.md](./algorithm-settings.md).

## Katib UI documentation

Please see [Katib UI README](https://github.com/kubeflow/katib/tree/master/pkg/ui/v1beta1).
Expand Down
305 changes: 187 additions & 118 deletions pkg/apis/manager/v1beta1/api.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions pkg/apis/manager/v1beta1/api.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ service Suggestion {
service EarlyStopping {
rpc GetEarlyStoppingRules(GetEarlyStoppingRulesRequest) returns (GetEarlyStoppingRulesReply);
rpc SetTrialStatus(SetTrialStatusRequest) returns (SetTrialStatusReply);
rpc ValidateEarlyStoppingSettings(ValidateEarlyStoppingSettingsRequest) returns (ValidateEarlyStoppingSettingsReply);
}

/**
Expand Down Expand Up @@ -339,6 +340,16 @@ message EarlyStoppingRule {
int32 start_step = 4;
}

message ValidateEarlyStoppingSettingsRequest {
EarlyStoppingSpec early_stopping = 1;
}

/**
* Return INVALID_ARGUMENT Error if Early Stopping Settings are not Valid
*/
message ValidateEarlyStoppingSettingsReply {
}

enum ComparisonType {
UNKNOWN_COMPARISON = 0; // Unknown comparison, not used
EQUAL = 1; // Equal comparison, e.g. accuracy = 0.7
Expand Down
28 changes: 28 additions & 0 deletions pkg/apis/manager/v1beta1/gen-doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
- [TrialStatus](#api.v1.beta1.TrialStatus)
- [ValidateAlgorithmSettingsReply](#api.v1.beta1.ValidateAlgorithmSettingsReply)
- [ValidateAlgorithmSettingsRequest](#api.v1.beta1.ValidateAlgorithmSettingsRequest)
- [ValidateEarlyStoppingSettingsReply](#api.v1.beta1.ValidateEarlyStoppingSettingsReply)
- [ValidateEarlyStoppingSettingsRequest](#api.v1.beta1.ValidateEarlyStoppingSettingsRequest)

- [ComparisonType](#api.v1.beta1.ComparisonType)
- [ObjectiveType](#api.v1.beta1.ObjectiveType)
Expand Down Expand Up @@ -696,6 +698,31 @@ Return INVALID_ARGUMENT Error if Algorithm Settings are not Valid




<a name="api.v1.beta1.ValidateEarlyStoppingSettingsReply"></a>

### ValidateEarlyStoppingSettingsReply
Return INVALID_ARGUMENT Error if Early Stopping Settings are not Valid






<a name="api.v1.beta1.ValidateEarlyStoppingSettingsRequest"></a>

### ValidateEarlyStoppingSettingsRequest



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| early_stopping | [EarlyStoppingSpec](#api.v1.beta1.EarlyStoppingSpec) | | |








Expand Down Expand Up @@ -784,6 +811,7 @@ EarlyStopping service defines APIs to manage Katib Early Stopping algorithms
| ----------- | ------------ | ------------- | ------------|
| GetEarlyStoppingRules | [GetEarlyStoppingRulesRequest](#api.v1.beta1.GetEarlyStoppingRulesRequest) | [GetEarlyStoppingRulesReply](#api.v1.beta1.GetEarlyStoppingRulesReply) | |
| SetTrialStatus | [SetTrialStatusRequest](#api.v1.beta1.SetTrialStatusRequest) | [SetTrialStatusReply](#api.v1.beta1.SetTrialStatusReply) | |
| ValidateEarlyStoppingSettings | [ValidateEarlyStoppingSettingsRequest](#api.v1.beta1.ValidateEarlyStoppingSettingsRequest) | [ValidateEarlyStoppingSettingsReply](#api.v1.beta1.ValidateEarlyStoppingSettingsReply) | |


<a name="api.v1.beta1.Suggestion"></a>
Expand Down
46 changes: 46 additions & 0 deletions pkg/apis/manager/v1beta1/gen-doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,14 @@ <h2>Table of Contents</h2>
<a href="#api.v1.beta1.ValidateAlgorithmSettingsRequest"><span class="badge">M</span>ValidateAlgorithmSettingsRequest</a>
</li>

<li>
<a href="#api.v1.beta1.ValidateEarlyStoppingSettingsReply"><span class="badge">M</span>ValidateEarlyStoppingSettingsReply</a>
</li>

<li>
<a href="#api.v1.beta1.ValidateEarlyStoppingSettingsRequest"><span class="badge">M</span>ValidateEarlyStoppingSettingsRequest</a>
</li>


<li>
<a href="#api.v1.beta1.ComparisonType"><span class="badge">E</span>ComparisonType</a>
Expand Down Expand Up @@ -1630,6 +1638,37 @@ <h3 id="api.v1.beta1.ValidateAlgorithmSettingsRequest">ValidateAlgorithmSettings



<h3 id="api.v1.beta1.ValidateEarlyStoppingSettingsReply">ValidateEarlyStoppingSettingsReply</h3>
<p>Return INVALID_ARGUMENT Error if Early Stopping Settings are not Valid</p>





<h3 id="api.v1.beta1.ValidateEarlyStoppingSettingsRequest">ValidateEarlyStoppingSettingsRequest</h3>
<p></p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>early_stopping</td>
<td><a href="#api.v1.beta1.EarlyStoppingSpec">EarlyStoppingSpec</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>







<h3 id="api.v1.beta1.ComparisonType">ComparisonType</h3>
Expand Down Expand Up @@ -1852,6 +1891,13 @@ <h3 id="api.v1.beta1.EarlyStopping">EarlyStopping</h3>
<td><p></p></td>
</tr>

<tr>
<td>ValidateEarlyStoppingSettings</td>
<td><a href="#api.v1.beta1.ValidateEarlyStoppingSettingsRequest">ValidateEarlyStoppingSettingsRequest</a></td>
<td><a href="#api.v1.beta1.ValidateEarlyStoppingSettingsReply">ValidateEarlyStoppingSettingsReply</a></td>
<td><p></p></td>
</tr>

</tbody>
</table>

Expand Down
Loading