v1beta1

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 31, 2023 License: Apache-2.0 Imports: 7 Imported by: 20

Documentation

Overview

Package v1beta1 contains API Schema definitions for the suggestion v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=suggestion.kubeflow.org

Package v1beta1 contains API Schema definitions for the suggestion v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=suggestion.kubeflow.org

Index

Constants

View Source 
const (
	Group   = "kubeflow.org"
	Version = "v1beta1"
)
View Source 
const (
	// SuggestionRestartReason is the reason for suggestion status when experiment is restarting
	SuggestionRestartReason = "Experiment is restarting"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
	AddToScheme   = SchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type Suggestion 

type Suggestion struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SuggestionSpec   `json:"spec,omitempty"`
	Status SuggestionStatus `json:"status,omitempty"`
}

Suggestion represents the structure of a Suggestion resource. +k8s:openapi-gen=true +kubebuilder:subresource:status

func (*Suggestion) DeepCopy 

func (in *Suggestion) DeepCopy() *Suggestion

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Suggestion.

func (*Suggestion) DeepCopyInto 

func (in *Suggestion) DeepCopyInto(out *Suggestion)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Suggestion) DeepCopyObject 

func (in *Suggestion) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Suggestion) IsCompleted 

func (suggestion *Suggestion) IsCompleted() bool

func (*Suggestion) IsCreated 

func (suggestion *Suggestion) IsCreated() bool

func (*Suggestion) IsDeploymentReady added in v0.10.0 

func (suggestion *Suggestion) IsDeploymentReady() bool

func (*Suggestion) IsFailed 

func (suggestion *Suggestion) IsFailed() bool

func (*Suggestion) IsRestarting added in v0.10.0 

func (suggestion *Suggestion) IsRestarting() bool

IsRestarting returns true if suggestion running status is false and reason = SuggestionRestartReason

func (*Suggestion) IsRunning 

func (suggestion *Suggestion) IsRunning() bool

func (*Suggestion) IsSucceeded 

func (suggestion *Suggestion) IsSucceeded() bool

func (*Suggestion) MarkSuggestionStatusCreated 

func (suggestion *Suggestion) MarkSuggestionStatusCreated(reason, message string)

func (*Suggestion) MarkSuggestionStatusDeploymentReady 

func (suggestion *Suggestion) MarkSuggestionStatusDeploymentReady(status v1.ConditionStatus, reason, message string)

func (*Suggestion) MarkSuggestionStatusFailed 

func (suggestion *Suggestion) MarkSuggestionStatusFailed(reason, message string)

func (*Suggestion) MarkSuggestionStatusRunning 

func (suggestion *Suggestion) MarkSuggestionStatusRunning(status v1.ConditionStatus, reason, message string)

MarkSuggestionStatusRunning sets suggestion Running status.

func (*Suggestion) MarkSuggestionStatusSucceeded 

func (suggestion *Suggestion) MarkSuggestionStatusSucceeded(reason, message string)

MarkSuggestionStatusSucceeded sets suggestion Succeeded status to true. Suggestion can be succeeded only if ResumeExperiment = Never or ResumeExperiment = FromVolume

type SuggestionCondition 

type SuggestionCondition struct {
	// Type of Suggestion condition.
	Type SuggestionConditionType `json:"type"`

	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`

	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

SuggestionCondition describes the state of the Suggestion at a certain point. +k8s:deepcopy-gen=true

func (*SuggestionCondition) DeepCopy 

func (in *SuggestionCondition) DeepCopy() *SuggestionCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SuggestionCondition.

func (*SuggestionCondition) DeepCopyInto 

func (in *SuggestionCondition) DeepCopyInto(out *SuggestionCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SuggestionConditionType 

type SuggestionConditionType string

SuggestionConditionType defines the state of a Suggestion. 

const (
	SuggestionCreated         SuggestionConditionType = "Created"
	SuggestionDeploymentReady SuggestionConditionType = "DeploymentReady"
	SuggestionRunning         SuggestionConditionType = "Running"
	SuggestionSucceeded       SuggestionConditionType = "Succeeded"
	SuggestionFailed          SuggestionConditionType = "Failed"
)

type SuggestionList 

type SuggestionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Suggestion `json:"items"`
}

SuggestionList contains a list of Suggestion

func (*SuggestionList) DeepCopy 

func (in *SuggestionList) DeepCopy() *SuggestionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SuggestionList.

func (*SuggestionList) DeepCopyInto 

func (in *SuggestionList) DeepCopyInto(out *SuggestionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SuggestionList) DeepCopyObject 

func (in *SuggestionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SuggestionSpec 

type SuggestionSpec struct {
	// Algorithm describes HP or NAS algorithm that suggestion is used.
	Algorithm *common.AlgorithmSpec `json:"algorithm,omitempty"`

	// EarlyStopping describes early stopping algorithm that suggestion is used.
	EarlyStopping *common.EarlyStoppingSpec `json:"earlyStopping,omitempty"`

	// Number of suggestions requested.
	Requests int32 `json:"requests,omitempty"`

	// ResumePolicy describes resuming policy which usually take effect after experiment terminated.
	// Default value is Never.
	ResumePolicy experiment.ResumePolicyType `json:"resumePolicy,omitempty"`
}

SuggestionSpec is the specification of a Suggestion.

func (*SuggestionSpec) DeepCopy 

func (in *SuggestionSpec) DeepCopy() *SuggestionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SuggestionSpec.

func (*SuggestionSpec) DeepCopyInto 

func (in *SuggestionSpec) DeepCopyInto(out *SuggestionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SuggestionStatus 

type SuggestionStatus struct {
	// AlgorithmSettings defines HP or NAS algorithm settings which suggestion gRPC service returns.
	// These settings overwrites Experiment's settings before the gRPC request.
	// It can be empty if settings haven't been changed.
	AlgorithmSettings []common.AlgorithmSetting `json:"algorithmSettings,omitempty"`

	// Number of suggestion results
	SuggestionCount int32 `json:"suggestionCount,omitempty"`

	// Suggestion results
	Suggestions []TrialAssignment `json:"suggestions,omitempty"`

	// Represents time when the Suggestion was acknowledged by the Suggestion controller.
	// It is not guaranteed to be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Represents time when the Suggestion was completed. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Represents last time when the Suggestion was reconciled. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"`

	// List of observed runtime conditions for this Suggestion.
	Conditions []SuggestionCondition `json:"conditions,omitempty"`
}

SuggestionStatus is the current status of a Suggestion.

func (*SuggestionStatus) DeepCopy 

func (in *SuggestionStatus) DeepCopy() *SuggestionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SuggestionStatus.

func (*SuggestionStatus) DeepCopyInto 

func (in *SuggestionStatus) DeepCopyInto(out *SuggestionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TrialAssignment 

type TrialAssignment struct {
	// Suggestion results with Trial parameters
	ParameterAssignments []common.ParameterAssignment `json:"parameterAssignments,omitempty"`

	// Name of the suggestion
	Name string `json:"name,omitempty"`

	// Rules for early stopping techniques
	// Contains rule name, value and comparison type
	EarlyStoppingRules []common.EarlyStoppingRule `json:"earlyStoppingRules,omitempty"`

	// Suggestion label metadata to attach to Trial job
	Labels map[string]string `json:"labels,omitempty"`
}

TrialAssignment is the assignment for one trial.

func (*TrialAssignment) DeepCopy 

func (in *TrialAssignment) DeepCopy() *TrialAssignment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TrialAssignment.

func (*TrialAssignment) DeepCopyInto 

func (in *TrialAssignment) DeepCopyInto(out *TrialAssignment)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.