v1beta1

Documentation

Overview

+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +groupName=kubeflow.org

Package v1beta1 contains API Schema definitions for the kubeflow v1beta1 API group +kubebuilder:object:generate=true +groupName=kubeflow.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type JobState
• type TrainingJob
  • func (in *TrainingJob) DeepCopy() *TrainingJob
  • func (in *TrainingJob) DeepCopyInto(out *TrainingJob)
  • func (in *TrainingJob) DeepCopyObject() runtime.Object
• type TrainingJobList
  • func (in *TrainingJobList) DeepCopy() *TrainingJobList
  • func (in *TrainingJobList) DeepCopyInto(out *TrainingJobList)
  • func (in *TrainingJobList) DeepCopyObject() runtime.Object
• type TrainingJobSpec
  • func (in *TrainingJobSpec) DeepCopy() *TrainingJobSpec
  • func (in *TrainingJobSpec) DeepCopyInto(out *TrainingJobSpec)
• type TrainingJobStatus
  • func (in *TrainingJobStatus) DeepCopy() *TrainingJobStatus
  • func (in *TrainingJobStatus) DeepCopyInto(out *TrainingJobStatus)

Constants

const KIND = "TrainingJob"

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "kubeflow.org", Version: "v1beta1"}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = GroupVersion

SchemeGroupVersion is group version used to register these objects.

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type JobState

type JobState string

const (
	Created    JobState = "Created"
	Restarting JobState = "Restarting"
	Pending    JobState = "Pending"
	Running    JobState = "Running"
	Succeeded  JobState = "Succeeded"
	Failed     JobState = "Failed"
	Unknown    JobState = "Unknown"
)

type TrainingJob

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

	Spec   TrainingJobSpec   `json:"spec,omitempty"`
	Status TrainingJobStatus `json:"status,omitempty"`
}

TrainingJob is the Schema for the trainingjobs API

func (*TrainingJob) DeepCopy

func (in *TrainingJob) DeepCopy() *TrainingJob

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

func (*TrainingJob) DeepCopyInto

func (in *TrainingJob) DeepCopyInto(out *TrainingJob)

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

func (*TrainingJob) DeepCopyObject

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

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

type TrainingJobList

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

TrainingJobList contains a list of TrainingJob

func (*TrainingJobList) DeepCopy

func (in *TrainingJobList) DeepCopy() *TrainingJobList

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

func (*TrainingJobList) DeepCopyInto

func (in *TrainingJobList) DeepCopyInto(out *TrainingJobList)

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

func (*TrainingJobList) DeepCopyObject

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

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

type TrainingJobSpec

type TrainingJobSpec struct {
	// Type indicates the training framework or workload type
	Type string `json:"type,omitempty"`

	// RunPolicy encapsulates various runtime policies of the distributed training
	// job, for example how to clean up resources and how long the job can stay
	// active.
	//+kubebuilder:validation:Optional
	RunPolicy kubeflowv1.RunPolicy `json:"runPolicy"`

	// ElasticPolicy aim to define global elastic configuration
	ElasticPolicy *kubeflowv1.ElasticPolicy `json:"elasticPolicy,omitempty"`

	// A map of ReplicaType (type) to ReplicaSpec (value).
	// For example,
	//   {
	//     "Master": PyTorchReplicaSpec,
	//     "Worker": PyTorchReplicaSpec,
	//   }
	ReplicaSpecs map[kubeflowv1.ReplicaType]*kubeflowv1.ReplicaSpec `json:"replicaSpecs"`

	// OptionalMap store user defined data.
	OptionalMap map[string]string `json:"optionalMap,omitempty"`
}

TrainingJobSpec defines the desired state of TrainingJob

func (*TrainingJobSpec) DeepCopy

func (in *TrainingJobSpec) DeepCopy() *TrainingJobSpec

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

func (*TrainingJobSpec) DeepCopyInto

func (in *TrainingJobSpec) DeepCopyInto(out *TrainingJobSpec)

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

type TrainingJobStatus

type TrainingJobStatus struct {
	kubeflowv1.JobStatus `json:"status,omitempty"`

	// State is a simple, high-level summary of where the Job is in its lifecycle
	// +optional
	State JobState `json:"state,omitempty"`
}

TrainingJobStatus defines the observed state of TrainingJob

func (*TrainingJobStatus) DeepCopy

func (in *TrainingJobStatus) DeepCopy() *TrainingJobStatus

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

func (*TrainingJobStatus) DeepCopyInto

func (in *TrainingJobStatus) DeepCopyInto(out *TrainingJobStatus)

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