plugins

package
v1.12.0 Latest Latest
Warning

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

Go to latest
Published: May 6, 2024 License: Apache-2.0 Imports: 5 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	RestartPolicy_name = map[int32]string{
		0: "RESTART_POLICY_NEVER",
		1: "RESTART_POLICY_ON_FAILURE",
		2: "RESTART_POLICY_ALWAYS",
	}
	RestartPolicy_value = map[string]int32{
		"RESTART_POLICY_NEVER":      0,
		"RESTART_POLICY_ON_FAILURE": 1,
		"RESTART_POLICY_ALWAYS":     2,
	}
)

Enum value maps for RestartPolicy.

View Source
var (
	CleanPodPolicy_name = map[int32]string{
		0: "CLEANPOD_POLICY_NONE",
		1: "CLEANPOD_POLICY_RUNNING",
		2: "CLEANPOD_POLICY_ALL",
	}
	CleanPodPolicy_value = map[string]int32{
		"CLEANPOD_POLICY_NONE":    0,
		"CLEANPOD_POLICY_RUNNING": 1,
		"CLEANPOD_POLICY_ALL":     2,
	}
)

Enum value maps for CleanPodPolicy.

View Source
var File_flyteidl_plugins_kubeflow_common_proto protoreflect.FileDescriptor
View Source
var File_flyteidl_plugins_kubeflow_mpi_proto protoreflect.FileDescriptor
View Source
var File_flyteidl_plugins_kubeflow_pytorch_proto protoreflect.FileDescriptor
View Source
var File_flyteidl_plugins_kubeflow_tensorflow_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CleanPodPolicy

type CleanPodPolicy int32
const (
	CleanPodPolicy_CLEANPOD_POLICY_NONE    CleanPodPolicy = 0
	CleanPodPolicy_CLEANPOD_POLICY_RUNNING CleanPodPolicy = 1
	CleanPodPolicy_CLEANPOD_POLICY_ALL     CleanPodPolicy = 2
)

func (CleanPodPolicy) Descriptor added in v1.10.7

func (CleanPodPolicy) Enum added in v1.10.7

func (x CleanPodPolicy) Enum() *CleanPodPolicy

func (CleanPodPolicy) EnumDescriptor deprecated

func (CleanPodPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use CleanPodPolicy.Descriptor instead.

func (CleanPodPolicy) Number added in v1.10.7

func (CleanPodPolicy) String

func (x CleanPodPolicy) String() string

func (CleanPodPolicy) Type added in v1.10.7

type DistributedMPITrainingReplicaSpec

type DistributedMPITrainingReplicaSpec struct {

	// Number of replicas
	Replicas int32 `protobuf:"varint,1,opt,name=replicas,proto3" json:"replicas,omitempty"`
	// Image used for the replica group
	Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// Resources required for the replica group
	Resources *core.Resources `protobuf:"bytes,3,opt,name=resources,proto3" json:"resources,omitempty"`
	// Restart policy determines whether pods will be restarted when they exit
	RestartPolicy RestartPolicy `` /* 146-byte string literal not displayed */
	// MPI sometimes requires different command set for different replica groups
	Command []string `protobuf:"bytes,5,rep,name=command,proto3" json:"command,omitempty"`
	// contains filtered or unexported fields
}

Replica specification for distributed MPI training

func (*DistributedMPITrainingReplicaSpec) Descriptor deprecated

func (*DistributedMPITrainingReplicaSpec) Descriptor() ([]byte, []int)

Deprecated: Use DistributedMPITrainingReplicaSpec.ProtoReflect.Descriptor instead.

func (*DistributedMPITrainingReplicaSpec) GetCommand

func (x *DistributedMPITrainingReplicaSpec) GetCommand() []string

func (*DistributedMPITrainingReplicaSpec) GetImage

func (*DistributedMPITrainingReplicaSpec) GetReplicas

func (x *DistributedMPITrainingReplicaSpec) GetReplicas() int32

func (*DistributedMPITrainingReplicaSpec) GetResources

func (*DistributedMPITrainingReplicaSpec) GetRestartPolicy

func (x *DistributedMPITrainingReplicaSpec) GetRestartPolicy() RestartPolicy

func (*DistributedMPITrainingReplicaSpec) ProtoMessage

func (*DistributedMPITrainingReplicaSpec) ProtoMessage()

func (*DistributedMPITrainingReplicaSpec) ProtoReflect added in v1.10.7

func (*DistributedMPITrainingReplicaSpec) Reset

func (*DistributedMPITrainingReplicaSpec) String

type DistributedMPITrainingTask

type DistributedMPITrainingTask struct {

	// Worker replicas spec
	WorkerReplicas *DistributedMPITrainingReplicaSpec `protobuf:"bytes,1,opt,name=worker_replicas,json=workerReplicas,proto3" json:"worker_replicas,omitempty"`
	// Master replicas spec
	LauncherReplicas *DistributedMPITrainingReplicaSpec `protobuf:"bytes,2,opt,name=launcher_replicas,json=launcherReplicas,proto3" json:"launcher_replicas,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.
	RunPolicy *RunPolicy `protobuf:"bytes,3,opt,name=run_policy,json=runPolicy,proto3" json:"run_policy,omitempty"`
	// Number of slots per worker
	Slots int32 `protobuf:"varint,4,opt,name=slots,proto3" json:"slots,omitempty"`
	// contains filtered or unexported fields
}

Proto for plugin that enables distributed training using https://github.com/kubeflow/mpi-operator

func (*DistributedMPITrainingTask) Descriptor deprecated

func (*DistributedMPITrainingTask) Descriptor() ([]byte, []int)

Deprecated: Use DistributedMPITrainingTask.ProtoReflect.Descriptor instead.

func (*DistributedMPITrainingTask) GetLauncherReplicas

func (*DistributedMPITrainingTask) GetRunPolicy

func (x *DistributedMPITrainingTask) GetRunPolicy() *RunPolicy

func (*DistributedMPITrainingTask) GetSlots

func (x *DistributedMPITrainingTask) GetSlots() int32

func (*DistributedMPITrainingTask) GetWorkerReplicas

func (*DistributedMPITrainingTask) ProtoMessage

func (*DistributedMPITrainingTask) ProtoMessage()

func (*DistributedMPITrainingTask) ProtoReflect added in v1.10.7

func (*DistributedMPITrainingTask) Reset

func (x *DistributedMPITrainingTask) Reset()

func (*DistributedMPITrainingTask) String

func (x *DistributedMPITrainingTask) String() string

type DistributedPyTorchTrainingReplicaSpec

type DistributedPyTorchTrainingReplicaSpec struct {

	// Number of replicas
	Replicas int32 `protobuf:"varint,1,opt,name=replicas,proto3" json:"replicas,omitempty"`
	// Image used for the replica group
	Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// Resources required for the replica group
	Resources *core.Resources `protobuf:"bytes,3,opt,name=resources,proto3" json:"resources,omitempty"`
	// RestartPolicy determines whether pods will be restarted when they exit
	RestartPolicy RestartPolicy `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DistributedPyTorchTrainingReplicaSpec) Descriptor deprecated

func (*DistributedPyTorchTrainingReplicaSpec) Descriptor() ([]byte, []int)

Deprecated: Use DistributedPyTorchTrainingReplicaSpec.ProtoReflect.Descriptor instead.

func (*DistributedPyTorchTrainingReplicaSpec) GetImage

func (*DistributedPyTorchTrainingReplicaSpec) GetReplicas

func (*DistributedPyTorchTrainingReplicaSpec) GetResources

func (*DistributedPyTorchTrainingReplicaSpec) GetRestartPolicy

func (*DistributedPyTorchTrainingReplicaSpec) ProtoMessage

func (*DistributedPyTorchTrainingReplicaSpec) ProtoMessage()

func (*DistributedPyTorchTrainingReplicaSpec) ProtoReflect added in v1.10.7

func (*DistributedPyTorchTrainingReplicaSpec) Reset

func (*DistributedPyTorchTrainingReplicaSpec) String

type DistributedPyTorchTrainingTask

type DistributedPyTorchTrainingTask struct {

	// Worker replicas spec
	WorkerReplicas *DistributedPyTorchTrainingReplicaSpec `protobuf:"bytes,1,opt,name=worker_replicas,json=workerReplicas,proto3" json:"worker_replicas,omitempty"`
	// Master replicas spec, master replicas can only have 1 replica
	MasterReplicas *DistributedPyTorchTrainingReplicaSpec `protobuf:"bytes,2,opt,name=master_replicas,json=masterReplicas,proto3" json:"master_replicas,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.
	RunPolicy *RunPolicy `protobuf:"bytes,3,opt,name=run_policy,json=runPolicy,proto3" json:"run_policy,omitempty"`
	// config for an elastic pytorch job
	ElasticConfig *ElasticConfig `protobuf:"bytes,4,opt,name=elastic_config,json=elasticConfig,proto3" json:"elastic_config,omitempty"`
	// contains filtered or unexported fields
}

Proto for plugin that enables distributed training using https://github.com/kubeflow/pytorch-operator

func (*DistributedPyTorchTrainingTask) Descriptor deprecated

func (*DistributedPyTorchTrainingTask) Descriptor() ([]byte, []int)

Deprecated: Use DistributedPyTorchTrainingTask.ProtoReflect.Descriptor instead.

func (*DistributedPyTorchTrainingTask) GetElasticConfig

func (x *DistributedPyTorchTrainingTask) GetElasticConfig() *ElasticConfig

func (*DistributedPyTorchTrainingTask) GetMasterReplicas

func (*DistributedPyTorchTrainingTask) GetRunPolicy

func (x *DistributedPyTorchTrainingTask) GetRunPolicy() *RunPolicy

func (*DistributedPyTorchTrainingTask) GetWorkerReplicas

func (*DistributedPyTorchTrainingTask) ProtoMessage

func (*DistributedPyTorchTrainingTask) ProtoMessage()

func (*DistributedPyTorchTrainingTask) ProtoReflect added in v1.10.7

func (*DistributedPyTorchTrainingTask) Reset

func (x *DistributedPyTorchTrainingTask) Reset()

func (*DistributedPyTorchTrainingTask) String

type DistributedTensorflowTrainingReplicaSpec

type DistributedTensorflowTrainingReplicaSpec struct {

	// Number of replicas
	Replicas int32 `protobuf:"varint,1,opt,name=replicas,proto3" json:"replicas,omitempty"`
	// Image used for the replica group
	Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// Resources required for the replica group
	Resources *core.Resources `protobuf:"bytes,3,opt,name=resources,proto3" json:"resources,omitempty"`
	// RestartPolicy Determines whether pods will be restarted when they exit
	RestartPolicy RestartPolicy `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DistributedTensorflowTrainingReplicaSpec) Descriptor deprecated

func (*DistributedTensorflowTrainingReplicaSpec) Descriptor() ([]byte, []int)

Deprecated: Use DistributedTensorflowTrainingReplicaSpec.ProtoReflect.Descriptor instead.

func (*DistributedTensorflowTrainingReplicaSpec) GetImage

func (*DistributedTensorflowTrainingReplicaSpec) GetReplicas

func (*DistributedTensorflowTrainingReplicaSpec) GetResources

func (*DistributedTensorflowTrainingReplicaSpec) GetRestartPolicy

func (*DistributedTensorflowTrainingReplicaSpec) ProtoMessage

func (*DistributedTensorflowTrainingReplicaSpec) ProtoReflect added in v1.10.7

func (*DistributedTensorflowTrainingReplicaSpec) Reset

func (*DistributedTensorflowTrainingReplicaSpec) String

type DistributedTensorflowTrainingTask

type DistributedTensorflowTrainingTask struct {

	// Worker replicas spec
	WorkerReplicas *DistributedTensorflowTrainingReplicaSpec `protobuf:"bytes,1,opt,name=worker_replicas,json=workerReplicas,proto3" json:"worker_replicas,omitempty"`
	// Parameter server replicas spec
	PsReplicas *DistributedTensorflowTrainingReplicaSpec `protobuf:"bytes,2,opt,name=ps_replicas,json=psReplicas,proto3" json:"ps_replicas,omitempty"`
	// Chief replicas spec
	ChiefReplicas *DistributedTensorflowTrainingReplicaSpec `protobuf:"bytes,3,opt,name=chief_replicas,json=chiefReplicas,proto3" json:"chief_replicas,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.
	RunPolicy *RunPolicy `protobuf:"bytes,4,opt,name=run_policy,json=runPolicy,proto3" json:"run_policy,omitempty"`
	// Evaluator replicas spec
	EvaluatorReplicas *DistributedTensorflowTrainingReplicaSpec `protobuf:"bytes,5,opt,name=evaluator_replicas,json=evaluatorReplicas,proto3" json:"evaluator_replicas,omitempty"`
	// contains filtered or unexported fields
}

Proto for plugin that enables distributed training using https://github.com/kubeflow/tf-operator

func (*DistributedTensorflowTrainingTask) Descriptor deprecated

func (*DistributedTensorflowTrainingTask) Descriptor() ([]byte, []int)

Deprecated: Use DistributedTensorflowTrainingTask.ProtoReflect.Descriptor instead.

func (*DistributedTensorflowTrainingTask) GetChiefReplicas

func (*DistributedTensorflowTrainingTask) GetEvaluatorReplicas added in v1.9.16

func (*DistributedTensorflowTrainingTask) GetPsReplicas

func (*DistributedTensorflowTrainingTask) GetRunPolicy

func (x *DistributedTensorflowTrainingTask) GetRunPolicy() *RunPolicy

func (*DistributedTensorflowTrainingTask) GetWorkerReplicas

func (*DistributedTensorflowTrainingTask) ProtoMessage

func (*DistributedTensorflowTrainingTask) ProtoMessage()

func (*DistributedTensorflowTrainingTask) ProtoReflect added in v1.10.7

func (*DistributedTensorflowTrainingTask) Reset

func (*DistributedTensorflowTrainingTask) String

type ElasticConfig

type ElasticConfig struct {
	RdzvBackend  string `protobuf:"bytes,1,opt,name=rdzv_backend,json=rdzvBackend,proto3" json:"rdzv_backend,omitempty"`
	MinReplicas  int32  `protobuf:"varint,2,opt,name=min_replicas,json=minReplicas,proto3" json:"min_replicas,omitempty"`
	MaxReplicas  int32  `protobuf:"varint,3,opt,name=max_replicas,json=maxReplicas,proto3" json:"max_replicas,omitempty"`
	NprocPerNode int32  `protobuf:"varint,4,opt,name=nproc_per_node,json=nprocPerNode,proto3" json:"nproc_per_node,omitempty"`
	MaxRestarts  int32  `protobuf:"varint,5,opt,name=max_restarts,json=maxRestarts,proto3" json:"max_restarts,omitempty"`
	// contains filtered or unexported fields
}

Custom proto for torch elastic config for distributed training using https://github.com/kubeflow/training-operator/blob/master/pkg/apis/kubeflow.org/v1/pytorch_types.go

func (*ElasticConfig) Descriptor deprecated

func (*ElasticConfig) Descriptor() ([]byte, []int)

Deprecated: Use ElasticConfig.ProtoReflect.Descriptor instead.

func (*ElasticConfig) GetMaxReplicas

func (x *ElasticConfig) GetMaxReplicas() int32

func (*ElasticConfig) GetMaxRestarts

func (x *ElasticConfig) GetMaxRestarts() int32

func (*ElasticConfig) GetMinReplicas

func (x *ElasticConfig) GetMinReplicas() int32

func (*ElasticConfig) GetNprocPerNode

func (x *ElasticConfig) GetNprocPerNode() int32

func (*ElasticConfig) GetRdzvBackend

func (x *ElasticConfig) GetRdzvBackend() string

func (*ElasticConfig) ProtoMessage

func (*ElasticConfig) ProtoMessage()

func (*ElasticConfig) ProtoReflect added in v1.10.7

func (x *ElasticConfig) ProtoReflect() protoreflect.Message

func (*ElasticConfig) Reset

func (x *ElasticConfig) Reset()

func (*ElasticConfig) String

func (x *ElasticConfig) String() string

type RestartPolicy

type RestartPolicy int32
const (
	RestartPolicy_RESTART_POLICY_NEVER      RestartPolicy = 0
	RestartPolicy_RESTART_POLICY_ON_FAILURE RestartPolicy = 1
	RestartPolicy_RESTART_POLICY_ALWAYS     RestartPolicy = 2
)

func (RestartPolicy) Descriptor added in v1.10.7

func (RestartPolicy) Enum added in v1.10.7

func (x RestartPolicy) Enum() *RestartPolicy

func (RestartPolicy) EnumDescriptor deprecated

func (RestartPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use RestartPolicy.Descriptor instead.

func (RestartPolicy) Number added in v1.10.7

func (RestartPolicy) String

func (x RestartPolicy) String() string

func (RestartPolicy) Type added in v1.10.7

type RunPolicy

type RunPolicy struct {

	// Defines the policy to kill pods after the job completes. Default to None.
	CleanPodPolicy CleanPodPolicy `` /* 152-byte string literal not displayed */
	// TTL to clean up jobs. Default to infinite.
	TtlSecondsAfterFinished int32 `` /* 135-byte string literal not displayed */
	// Specifies the duration in seconds relative to the startTime that the job may be active
	// before the system tries to terminate it; value must be positive integer.
	ActiveDeadlineSeconds int32 `` /* 127-byte string literal not displayed */
	// Number of retries before marking this job failed.
	BackoffLimit int32 `protobuf:"varint,4,opt,name=backoff_limit,json=backoffLimit,proto3" json:"backoff_limit,omitempty"`
	// contains filtered or unexported fields
}

func (*RunPolicy) Descriptor deprecated

func (*RunPolicy) Descriptor() ([]byte, []int)

Deprecated: Use RunPolicy.ProtoReflect.Descriptor instead.

func (*RunPolicy) GetActiveDeadlineSeconds

func (x *RunPolicy) GetActiveDeadlineSeconds() int32

func (*RunPolicy) GetBackoffLimit

func (x *RunPolicy) GetBackoffLimit() int32

func (*RunPolicy) GetCleanPodPolicy

func (x *RunPolicy) GetCleanPodPolicy() CleanPodPolicy

func (*RunPolicy) GetTtlSecondsAfterFinished

func (x *RunPolicy) GetTtlSecondsAfterFinished() int32

func (*RunPolicy) ProtoMessage

func (*RunPolicy) ProtoMessage()

func (*RunPolicy) ProtoReflect added in v1.10.7

func (x *RunPolicy) ProtoReflect() protoreflect.Message

func (*RunPolicy) Reset

func (x *RunPolicy) Reset()

func (*RunPolicy) String

func (x *RunPolicy) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL