-
Notifications
You must be signed in to change notification settings - Fork 420
/
status_util.go
196 lines (166 loc) · 7.37 KB
/
status_util.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package util
import (
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
commonv1alpha3 "github.com/kubeflow/katib/pkg/apis/controller/common/v1alpha3"
experimentsv1alpha3 "github.com/kubeflow/katib/pkg/apis/controller/experiments/v1alpha3"
trialsv1alpha3 "github.com/kubeflow/katib/pkg/apis/controller/trials/v1alpha3"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
var log = logf.Log.WithName("experiment-status-util")
const (
ExperimentCreatedReason = "ExperimentCreated"
ExperimentRunningReason = "ExperimentRunning"
ExperimentRestartingReason = "ExperimentRestarting"
ExperimentGoalReachedReason = "ExperimentGoalReached"
ExperimentMaxTrialsReachedReason = "ExperimentMaxTrialsReached"
ExperimentSuggestionEndReachedReason = "ExperimentSuggestionEndReached"
ExperimentFailedReason = "ExperimentFailed"
ExperimentKilledReason = "ExperimentKilled"
)
func UpdateExperimentStatus(collector *ExperimentsCollector, instance *experimentsv1alpha3.Experiment, trials *trialsv1alpha3.TrialList) error {
isObjectiveGoalReached := updateTrialsSummary(instance, trials)
if !instance.IsCompleted() {
UpdateExperimentStatusCondition(collector, instance, isObjectiveGoalReached, false)
}
return nil
}
func updateTrialsSummary(instance *experimentsv1alpha3.Experiment, trials *trialsv1alpha3.TrialList) bool {
var bestTrialValue float64
sts := &instance.Status
sts.Trials = 0
sts.RunningTrialList, sts.PendingTrialList, sts.FailedTrialList, sts.SucceededTrialList, sts.KilledTrialList = nil, nil, nil, nil, nil
bestTrialIndex := -1
isObjectiveGoalReached := false
var objectiveValueGoal float64
if instance.Spec.Objective.Goal != nil {
objectiveValueGoal = *instance.Spec.Objective.Goal
}
objectiveType := instance.Spec.Objective.Type
objectiveMetricName := instance.Spec.Objective.ObjectiveMetricName
for index, trial := range trials.Items {
sts.Trials++
if trial.IsKilled() {
sts.KilledTrialList = append(sts.KilledTrialList, trial.Name)
} else if trial.IsFailed() {
sts.FailedTrialList = append(sts.FailedTrialList, trial.Name)
} else if trial.IsSucceeded() {
sts.SucceededTrialList = append(sts.SucceededTrialList, trial.Name)
} else if trial.IsRunning() {
sts.RunningTrialList = append(sts.RunningTrialList, trial.Name)
} else {
sts.PendingTrialList = append(sts.PendingTrialList, trial.Name)
}
objectiveMetricValue := getObjectiveMetricValue(trial, objectiveMetricName)
if objectiveMetricValue == nil {
continue
}
//intialize vars to objective metric value of the first trial
if bestTrialIndex == -1 {
bestTrialValue = *objectiveMetricValue
bestTrialIndex = index
}
if objectiveType == commonv1alpha3.ObjectiveTypeMinimize {
if *objectiveMetricValue < bestTrialValue {
bestTrialValue = *objectiveMetricValue
bestTrialIndex = index
}
if instance.Spec.Objective.Goal != nil && bestTrialValue <= objectiveValueGoal {
isObjectiveGoalReached = true
}
} else if objectiveType == commonv1alpha3.ObjectiveTypeMaximize {
if *objectiveMetricValue > bestTrialValue {
bestTrialValue = *objectiveMetricValue
bestTrialIndex = index
}
if instance.Spec.Objective.Goal != nil && bestTrialValue >= objectiveValueGoal {
isObjectiveGoalReached = true
}
}
}
sts.TrialsRunning = int32(len(sts.RunningTrialList))
sts.TrialsPending = int32(len(sts.PendingTrialList))
sts.TrialsSucceeded = int32(len(sts.SucceededTrialList))
sts.TrialsFailed = int32(len(sts.FailedTrialList))
sts.TrialsKilled = int32(len(sts.KilledTrialList))
// if best trial is set
if bestTrialIndex != -1 {
bestTrial := trials.Items[bestTrialIndex]
sts.CurrentOptimalTrial.BestTrialName = bestTrial.Name
sts.CurrentOptimalTrial.ParameterAssignments = []commonv1alpha3.ParameterAssignment{}
for _, parameterAssigment := range bestTrial.Spec.ParameterAssignments {
sts.CurrentOptimalTrial.ParameterAssignments = append(sts.CurrentOptimalTrial.ParameterAssignments, parameterAssigment)
}
sts.CurrentOptimalTrial.Observation.Metrics = []commonv1alpha3.Metric{}
for _, metric := range bestTrial.Status.Observation.Metrics {
sts.CurrentOptimalTrial.Observation.Metrics = append(sts.CurrentOptimalTrial.Observation.Metrics, metric)
}
}
return isObjectiveGoalReached
}
func getObjectiveMetricValue(trial trialsv1alpha3.Trial, objectiveMetricName string) *float64 {
if trial.Status.Observation == nil {
return nil
}
for _, metric := range trial.Status.Observation.Metrics {
if objectiveMetricName == metric.Name {
return &metric.Value
}
}
return nil
}
// UpdateExperimentStatusCondition updates the experiment status.
func UpdateExperimentStatusCondition(collector *ExperimentsCollector, instance *experimentsv1alpha3.Experiment, isObjectiveGoalReached bool, getSuggestionDone bool) {
completedTrialsCount := instance.Status.TrialsSucceeded + instance.Status.TrialsFailed + instance.Status.TrialsKilled
failedTrialsCount := instance.Status.TrialsFailed
activeTrialsCount := instance.Status.TrialsPending + instance.Status.TrialsRunning
now := metav1.Now()
if isObjectiveGoalReached {
msg := "Experiment has succeeded because Objective goal has reached"
instance.MarkExperimentStatusSucceeded(ExperimentGoalReachedReason, msg)
instance.Status.CompletionTime = &now
collector.IncreaseExperimentsSucceededCount(instance.Namespace)
return
}
// First check if MaxFailedTrialCount is reached.
if (instance.Spec.MaxFailedTrialCount != nil) && (failedTrialsCount > *instance.Spec.MaxFailedTrialCount) {
msg := "Experiment has failed because max failed count has reached"
instance.MarkExperimentStatusFailed(ExperimentFailedReason, msg)
instance.Status.CompletionTime = &now
collector.IncreaseExperimentsFailedCount(instance.Namespace)
return
}
// Then Check if MaxTrialCount is reached.
if (instance.Spec.MaxTrialCount != nil) && (completedTrialsCount >= *instance.Spec.MaxTrialCount) {
msg := "Experiment has succeeded because max trial count has reached"
instance.MarkExperimentStatusSucceeded(ExperimentMaxTrialsReachedReason, msg)
instance.Status.CompletionTime = &now
collector.IncreaseExperimentsSucceededCount(instance.Namespace)
return
}
if getSuggestionDone && activeTrialsCount == 0 {
msg := "Experiment has succeeded because suggestion service has reached the end"
instance.MarkExperimentStatusSucceeded(ExperimentSuggestionEndReachedReason, msg)
instance.Status.CompletionTime = &now
collector.IncreaseExperimentsSucceededCount(instance.Namespace)
return
}
msg := "Experiment is running"
instance.MarkExperimentStatusRunning(ExperimentRunningReason, msg)
}
func IsCompletedExperimentRestartable(instance *experimentsv1alpha3.Experiment) bool {
if instance.IsSucceeded() && instance.IsCompletedReason(ExperimentMaxTrialsReachedReason) && instance.Spec.ResumePolicy == experimentsv1alpha3.LongRunning {
return true
}
return false
}