package
0.18.0-rc.0
Repository: https://github.com/kubeflow/katib.git
Documentation: pkg.go.dev

# Constants

ActionTypeCreate is the create CRUD action.
ActionTypeDelete is the delete CRUD action.
ActionTypeGet is the get CRUD action.
ActionTypeList is the list CRUD action.
ActionTypeUpdate is the update CRUD action.
AnnotationIstioSidecarInjectName is the annotation of Istio Sidecar.
AnnotationIstioSidecarInjectValue is the value of Istio Sidecar annotation.
CertDir is the location saved certs for the webhooks.
ConfigEnableGRPCProbeInSuggestion is the config name which indicates if we should set GRPC probe in suggestion deployments.
ConfigExperimentSuggestionName is the config name of the suggestion client implementation in experiment controller.
ConfigInjectSecurityContext is the config name which indicates if we should inject the security context into the metrics collector sidecar.
ConfigTrialResources is the config name which indicates resources list which can be used as trial template.
ContainerEarlyStopping is the container name to run EarlyStopping service.
ContainerSuggestion is the container name to run Suggestion service.
ContainerSuggestionVolumeName is the volume name that mounted on suggestion container.
DefaultEarlyStoppingPort is the default port of EarlyStopping service.
DefaultEarlyStoppingPortName is the default port name of EarlyStopping service.
DefaultGRPCRetryAttempts is the the maximum number of retries for gRPC calls.
DefaultGRPCRetryPeriod is a fixed period of time between gRPC call retries.
DefaultKatibComposerEnvName is the default env name of katib suggestion composer.
DefaultKatibDBManagerServiceIPEnvName is the env name of Katib DB Manager IP.
DefaultKatibDBManagerServiceNamespaceEnvName is the env name of Katib DB Manager namespace.
DefaultKatibDBManagerServicePortEnvName is the env name of Katib DB Manager Port.
DefaultKatibNamespaceEnvName is the default env name of katib namespace.
DefaultSuggestionPort is the default port of Suggestion service.
DefaultSuggestionPortName is the default port name of Suggestion service.
EnvTrialName is the env variable of Trial name.
JobKindJob is the kind of the Kubernetes Job.
KatibConfigMapName is the configmap name which includes Katib's configuration.
LabelDeploymentName is the label of deployment name.
LabelExperimentName is the label of experiment name.
LabelKatibConfigTag is the name of the config in Katib ConfigMap.
LabelSuggestionName is the label of suggestion name.
LabelTrialName is the label of trial name.
LabelTrialTemplateConfigMapName is the label name for the Trial templates configMap.
LabelTrialTemplateConfigMapValue is the label value for the Trial templates configMap.
PluralExperiment is the plural for Experiment object.
PluralSuggestion is the plural for Suggestion object.
PluralTrial is the plural for Trial object.
ReconcileErrorReason is the reason when there is a reconcile error.
SuggestionVolumeMountKey specifies the AlgorithmSettings key used to toggle Suggestion managed trial storage.
valid keys of trial metadata which are used to make substitution in Trial template.
TrialTemplateMetaParseFormatRegex is the regex to parse the index of Annotations and Labels from meta key.
TrialTemplateMetaReplaceFormatRegex is the regex for TrialMetadata format in Trial template.
TrialTemplateParamReplaceFormat is the format to make substitution in Trial template from Names in TrialParameters E.g if Name = learningRate, according value in Trial template must be ${trialParameters.learningRate}.
TrialTemplateParamReplaceFormatRegex is the regex for TrialParameters format in Trial template.
UnavailableMetricValue is the value when metric was not reported or metric value can't be converted to float64 This value is recorded in to DB when metrics collector can't parse objective metric from the training logs.

# Variables

DefaultComposer is the default composer of katib suggestion.
DefaultGRPCService is the default suggestion service name, which is used to run healthz check using grpc probe.
DefaultKatibDBManagerServiceIP is the default IP of Katib DB Manager.
DefaultKatibDBManagerServiceNamespace is the default namespace of Katib DB Manager.
DefaultKatibDBManagerServicePort is the default Port of Katib DB Manager.
DefaultKatibNamespace is the default namespace of katib deployment.
List of all valid keys of trial metadata for substitution in Trial template.