experiments

Documentation

Index

• Constants
• func Completion(ctx context.Context, api experimentsv1alpha1.API, args []string, ...) ([]string, cobra.ShellCompDirective)
• func NewDeleteCommand(o *DeleteOptions) *cobra.Command
• func NewGetCommand(o *GetOptions) *cobra.Command
• func NewLabelCommand(o *LabelOptions) *cobra.Command
• func NewSuggestCommand(o *SuggestOptions) *cobra.Command
• type DeleteOptions
• type GetOptions
• type LabelOptions
• type Options
• type SuggestOptions
  • func (o *SuggestOptions) AddLabels(ta *experimentsv1alpha1.TrialAssignments) error
  • func (o *SuggestOptions) SuggestAssignments(exp *experimentsv1alpha1.Experiment, ta *experimentsv1alpha1.TrialAssignments) error

Constants

const (
	DefaultNone     = "none"
	DefaultMinimum  = "min"
	DefaultMaximum  = "max"
	DefaultRandom   = "rand"
	DefaultBaseline = "base"
)

Functions

func Completion

func Completion(ctx context.Context, api experimentsv1alpha1.API, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

Completion implements argument completion for the type/name arguments.

func NewDeleteCommand

func NewDeleteCommand(o *DeleteOptions) *cobra.Command

NewDeleteCommand creates a new deletion command

func NewGetCommand

func NewGetCommand(o *GetOptions) *cobra.Command

NewGetCommand creates a new get command

func NewLabelCommand

func NewLabelCommand(o *LabelOptions) *cobra.Command

NewLabelCommand creates a new label command

func NewSuggestCommand

func NewSuggestCommand(o *SuggestOptions) *cobra.Command

NewSuggestCommand creates a new suggestion command

Types

type DeleteOptions

type DeleteOptions struct {
	Options

	// IgnoreNotFound treats missing resources as successful deletes
	IgnoreNotFound bool
}

DeleteOptions includes the configuration for deleting experiment API objects

type GetOptions

type GetOptions struct {
	Options

	ChunkSize int
	SortBy    string
	Selector  string
	All       bool
}

GetOptions includes the configuration for getting experiment API objects

type LabelOptions

type LabelOptions struct {
	Options

	// Labels to apply
	Labels map[string]string
}

LabelOptions includes the configuration for deleting experiment API objects

type Options

type Options struct {
	// Config is the Optimize Configuration
	Config *config.OptimizeConfig
	// ExperimentsAPI is used to interact with the Optimize Experiments API
	ExperimentsAPI experimentsv1alpha1.API
	// Printer is the resource printer used to render objects from the Optimize Experiments API
	Printer commander.ResourcePrinter
	// IOStreams are used to access the standard process streams
	commander.IOStreams

	// Names of the resources to work with
	Names []name
}

Options are the common options for interacting with the Optimize Experiments API

type SuggestOptions

type SuggestOptions struct {
	Options

	Assignments      map[string]string
	AllowInteractive bool
	DefaultBehavior  string
	Labels           string
	Baselines        map[string]*api.NumberOrString
}

SuggestOptions includes the configuration for suggesting experiment trials

func (*SuggestOptions) AddLabels

func (o *SuggestOptions) AddLabels(ta *experimentsv1alpha1.TrialAssignments) error

func (*SuggestOptions) SuggestAssignments

func (o *SuggestOptions) SuggestAssignments(exp *experimentsv1alpha1.Experiment, ta *experimentsv1alpha1.TrialAssignments) error

SuggestAssignments creates new assignments object based on the parameters of the supplied experiment