v1

Documentation

Index

• type HyperparameterTuningJob
• type HyperparameterTuningJobList
• type HyperparameterTuningJobSpec
• type HyperparameterTuningJobStatus

Types

type HyperparameterTuningJob

type HyperparameterTuningJob struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   HyperparameterTuningJobSpec   `json:"spec,omitempty"`
	Status HyperparameterTuningJobStatus `json:"status,omitempty"`
}

HyperparameterTuningJob is the Schema for the hyperparametertuningjobs API

type HyperparameterTuningJobList

type HyperparameterTuningJobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []HyperparameterTuningJob `json:"items"`
}

HyperparameterTuningJobList contains a list of HyperparameterTuningJob

type HyperparameterTuningJobSpec

type HyperparameterTuningJobSpec struct {
	HyperParameterTuningJobConfig *commonv1.HyperParameterTuningJobConfig `json:"hyperParameterTuningJobConfig"`

	HyperParameterTuningJobName *string `json:"hyperParameterTuningJobName,omitempty"`

	Tags []commonv1.Tag `json:"tags,omitempty"`

	TrainingJobDefinition *commonv1.HyperParameterTrainingJobDefinition `json:"trainingJobDefinition,omitempty"`

	WarmStartConfig *commonv1.HyperParameterTuningJobWarmStartConfig `json:"warmStartConfig,omitempty"`

	// +kubebuilder:validation:MinLength=1
	Region *string `json:"region"`

	// A custom SageMaker endpoint to use when communicating with SageMaker.
	// +kubebuilder:validation:Pattern=^(https|http)://.*$
	SageMakerEndpoint *string `json:"sageMakerEndpoint,omitempty"`
}

HyperparameterTuningJobSpec defines the desired state of HyperparameterTuningJob These are taken from aws-go-sdk-v2 and modified to use Kubebuilder validation and json omitempty instead of aws-go-sdk-v2 validation and required parameter notation, respectively.

type HyperparameterTuningJobStatus

type HyperparameterTuningJobStatus struct {
	// Field to store additional information, for example if
	// we are unable to check the status we update this.
	Additional string `json:"additional,omitempty"`

	// The status of HyperParameterTrainingJob
	// https://docs.aws.amazon.com/sagemaker/latest/dg/API_DescribeHyperParameterTuningJob.html#SageMaker-DescribeHyperParameterTuningJob-response-HyperParameterTuningJobStatus
	HyperParameterTuningJobStatus string `json:"hyperParameterTuningJobStatus,omitempty"`

	// A HyperParameterTrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
	// See https://docs.aws.amazon.com/sagemaker/latest/dg/API_DescribeHyperParameterTuningJob.html#SageMaker-DescribeHyperParameterTuningJob-response-BestTrainingJob
	BestTrainingJob *commonv1.HyperParameterTrainingJobSummary `json:"bestTrainingJob,omitempty"`

	// The last time that we checked the status of the SageMaker job.
	LastCheckTime *metav1.Time `json:"lastCheckTime,omitempty"`

	//SageMaker hyperparametertuning job name
	SageMakerHyperParameterTuningJobName string `json:"sageMakerHyperParameterTuningJobName,omitempty"`

	// The TrainingJobStatusCounters object that specifies the number of training
	// jobs, categorized by status, that this tuning job launched.
	// https://docs.aws.amazon.com/sagemaker/latest/dg/API_TrainingJobStatusCounters.html
	TrainingJobStatusCounters *commonv1.TrainingJobStatusCounters `json:"trainingJobStatusCounters,omitempty"`
}

HyperparameterTuningJobStatus defines the observed state of HyperparameterTuningJob