manifest

Documentation

Index

• type DefaultGenerator
  • func (g *DefaultGenerator) GetMetricsCollectorConfigData(cKind commonapiv1beta1.CollectorKind) (katibconfig.MetricsCollectorConfig, error)
  • func (g *DefaultGenerator) GetRunSpecWithHyperParameters(experiment *experimentsv1beta1.Experiment, trialName, trialNamespace string, ...) (*unstructured.Unstructured, error)
  • func (g *DefaultGenerator) GetSuggestionConfigData(algorithmName string) (katibconfig.SuggestionConfig, error)
  • func (g *DefaultGenerator) GetTrialTemplate(instance *experimentsv1beta1.Experiment) (string, error)
  • func (g *DefaultGenerator) InjectClient(c client.Client)
• type Generator
  • func New(c client.Client) Generator

Types

type DefaultGenerator

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

DefaultGenerator is the default implementation of Generator.

func (*DefaultGenerator) GetMetricsCollectorConfigData

func (g *DefaultGenerator) GetMetricsCollectorConfigData(cKind commonapiv1beta1.CollectorKind) (katibconfig.MetricsCollectorConfig, error)

GetMetricsCollectorConfigData returns metrics collector configuration for a given collector kind.

func (*DefaultGenerator) GetRunSpecWithHyperParameters

func (g *DefaultGenerator) GetRunSpecWithHyperParameters(experiment *experimentsv1beta1.Experiment, trialName, trialNamespace string, assignments []commonapiv1beta1.ParameterAssignment) (*unstructured.Unstructured, error)

GetRunSpecWithHyperParameters returns the specification for trial with hyperparameters.

func (*DefaultGenerator) GetSuggestionConfigData

func (g *DefaultGenerator) GetSuggestionConfigData(algorithmName string) (katibconfig.SuggestionConfig, error)

GetSuggestionConfigData returns suggestion configuration for a given algorithm name.

func (*DefaultGenerator) GetTrialTemplate

func (g *DefaultGenerator) GetTrialTemplate(instance *experimentsv1beta1.Experiment) (string, error)

GetTrialTemplate returns string Trial template from experiment

func (*DefaultGenerator) InjectClient

func (g *DefaultGenerator) InjectClient(c client.Client)

type Generator

type Generator interface {
	InjectClient(c client.Client)
	GetTrialTemplate(instance *experimentsv1beta1.Experiment) (string, error)
	GetRunSpecWithHyperParameters(experiment *experimentsv1beta1.Experiment, trialName, trialNamespace string, assignments []commonapiv1beta1.ParameterAssignment) (*unstructured.Unstructured, error)
	GetSuggestionConfigData(algorithmName string) (katibconfig.SuggestionConfig, error)
	GetMetricsCollectorConfigData(cKind commonapiv1beta1.CollectorKind) (katibconfig.MetricsCollectorConfig, error)
}

Generator is the type for manifests Generator.

func New

func New(c client.Client) Generator

New creates a new Generator.