federatedlearning

Documentation

Index

• Constants
• Variables
• func IsJobFinished(j *sednav1.FederatedLearningJob) bool
• func New(cc *runtime.ControllerContext) (runtime.FeatureControllerI, error)
• func NewJobCondition(conditionType sednav1.FLJobConditionType, reason, message string) sednav1.FLJobCondition
• type Controller
  • func (c *Controller) Run(stopCh <-chan struct{})
  • func (c *Controller) SetDownstreamSendFunc(f runtime.DownstreamSendFunc) error
  • func (c *Controller) SetUpstreamHandler(addFunc runtime.UpstreamHandlerAddFunc) error

Constants

const (
	// KindName is the kind name of CR this controller controls
	KindName = "FederatedLearningJob"
	// Name is this controller name
	Name = "FederatedLearning"
)

Variables

var Kind = sednav1.SchemeGroupVersion.WithKind(KindName)

Kind contains the schema.GroupVersionKind for this controller type.

Functions

func IsJobFinished

func IsJobFinished(j *sednav1.FederatedLearningJob) bool

func New

func New(cc *runtime.ControllerContext) (runtime.FeatureControllerI, error)

New creates a new federated learning job controller that keeps the relevant pods in sync with their corresponding FederatedLearningJob objects.

func NewJobCondition

func NewJobCondition(conditionType sednav1.FLJobConditionType, reason, message string) sednav1.FLJobCondition

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller ensures that all FederatedLearningJob objects have corresponding pods to run their configured workload.

func (*Controller) Run

func (c *Controller) Run(stopCh <-chan struct{})

Run starts the main goroutine responsible for watching and syncing jobs.

func (*Controller) SetDownstreamSendFunc

func (c *Controller) SetDownstreamSendFunc(f runtime.DownstreamSendFunc) error

func (*Controller) SetUpstreamHandler

func (c *Controller) SetUpstreamHandler(addFunc runtime.UpstreamHandlerAddFunc) error