plugins

package
v0.18.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2021 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var AlgorithmName_Value_name = map[int32]string{
	0: "CUSTOM",
	1: "XGBOOST",
}
View Source
var AlgorithmName_Value_value = map[string]int32{
	"CUSTOM":  0,
	"XGBOOST": 1,
}
View Source
var DistributedProtocol_Value_name = map[int32]string{
	0: "UNSPECIFIED",
	1: "MPI",
}
View Source
var DistributedProtocol_Value_value = map[string]int32{
	"UNSPECIFIED": 0,
	"MPI":         1,
}
View Source
var HyperparameterScalingType_Value_name = map[int32]string{
	0: "AUTO",
	1: "LINEAR",
	2: "LOGARITHMIC",
	3: "REVERSELOGARITHMIC",
}
View Source
var HyperparameterScalingType_Value_value = map[string]int32{
	"AUTO":               0,
	"LINEAR":             1,
	"LOGARITHMIC":        2,
	"REVERSELOGARITHMIC": 3,
}
View Source
var HyperparameterTuningObjectiveType_Value_name = map[int32]string{
	0: "MINIMIZE",
	1: "MAXIMIZE",
}
View Source
var HyperparameterTuningObjectiveType_Value_value = map[string]int32{
	"MINIMIZE": 0,
	"MAXIMIZE": 1,
}
View Source
var HyperparameterTuningStrategy_Value_name = map[int32]string{
	0: "BAYESIAN",
	1: "RANDOM",
}
View Source
var HyperparameterTuningStrategy_Value_value = map[string]int32{
	"BAYESIAN": 0,
	"RANDOM":   1,
}
View Source
var InputContentType_Value_name = map[int32]string{
	0: "TEXT_CSV",
}
View Source
var InputContentType_Value_value = map[string]int32{
	"TEXT_CSV": 0,
}
View Source
var InputMode_Value_name = map[int32]string{
	0: "FILE",
	1: "PIPE",
}
View Source
var InputMode_Value_value = map[string]int32{
	"FILE": 0,
	"PIPE": 1,
}
View Source
var TrainingJobEarlyStoppingType_Value_name = map[int32]string{
	0: "OFF",
	1: "AUTO",
}
View Source
var TrainingJobEarlyStoppingType_Value_value = map[string]int32{
	"OFF":  0,
	"AUTO": 1,
}

Functions

This section is empty.

Types

type AlgorithmName

type AlgorithmName struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The algorithm name is used for deciding which pre-built image to point to. This is only required for use cases where SageMaker's built-in algorithm mode is used. While we currently only support a subset of the algorithms, more will be added to the list. See: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html

func (*AlgorithmName) Descriptor

func (*AlgorithmName) Descriptor() ([]byte, []int)

func (*AlgorithmName) ProtoMessage

func (*AlgorithmName) ProtoMessage()

func (*AlgorithmName) Reset

func (m *AlgorithmName) Reset()

func (*AlgorithmName) String

func (m *AlgorithmName) String() string

func (*AlgorithmName) Validate

func (m *AlgorithmName) Validate() error

Validate checks the field values on AlgorithmName with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*AlgorithmName) XXX_DiscardUnknown

func (m *AlgorithmName) XXX_DiscardUnknown()

func (*AlgorithmName) XXX_Marshal

func (m *AlgorithmName) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AlgorithmName) XXX_Merge

func (m *AlgorithmName) XXX_Merge(src proto.Message)

func (*AlgorithmName) XXX_Size

func (m *AlgorithmName) XXX_Size() int

func (*AlgorithmName) XXX_Unmarshal

func (m *AlgorithmName) XXX_Unmarshal(b []byte) error

type AlgorithmNameValidationError

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

AlgorithmNameValidationError is the validation error returned by AlgorithmName.Validate if the designated constraints aren't met.

func (AlgorithmNameValidationError) Cause

Cause function returns cause value.

func (AlgorithmNameValidationError) Error

Error satisfies the builtin error interface

func (AlgorithmNameValidationError) ErrorName

func (e AlgorithmNameValidationError) ErrorName() string

ErrorName returns error name.

func (AlgorithmNameValidationError) Field

Field function returns field value.

func (AlgorithmNameValidationError) Key

Key function returns key value.

func (AlgorithmNameValidationError) Reason

Reason function returns reason value.

type AlgorithmName_Value

type AlgorithmName_Value int32
const (
	AlgorithmName_CUSTOM  AlgorithmName_Value = 0
	AlgorithmName_XGBOOST AlgorithmName_Value = 1
)

func (AlgorithmName_Value) EnumDescriptor

func (AlgorithmName_Value) EnumDescriptor() ([]byte, []int)

func (AlgorithmName_Value) String

func (x AlgorithmName_Value) String() string

type AlgorithmSpecification

type AlgorithmSpecification struct {
	// The input mode can be either PIPE or FILE
	InputMode InputMode_Value `` /* 137-byte string literal not displayed */
	// The algorithm name is used for deciding which pre-built image to point to
	AlgorithmName AlgorithmName_Value `` /* 153-byte string literal not displayed */
	// The algorithm version field is used for deciding which pre-built image to point to
	// This is only needed for use cases where SageMaker's built-in algorithm mode is chosen
	AlgorithmVersion string `protobuf:"bytes,3,opt,name=algorithm_version,json=algorithmVersion,proto3" json:"algorithm_version,omitempty"`
	// A list of metric definitions for SageMaker to evaluate/track on the progress of the training job
	// See this: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html
	// and this: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html
	MetricDefinitions []*MetricDefinition `protobuf:"bytes,4,rep,name=metric_definitions,json=metricDefinitions,proto3" json:"metric_definitions,omitempty"`
	// The content type of the input
	// See https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-training.html
	// https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html
	InputContentType     InputContentType_Value `` /* 167-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

Specifies the training algorithm to be used in the training job This object is mostly a pass-through, with a couple of exceptions include: (1) in Flyte, users don't need to specify TrainingImage; either use the built-in algorithm mode by using Flytekit's Simple Training Job and specifying an algorithm name and an algorithm version or (2) when users want to supply custom algorithms they should set algorithm_name field to CUSTOM. In this case, the value of the algorithm_version field has no effect For pass-through use cases: refer to this AWS official document for more details https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html

func (*AlgorithmSpecification) Descriptor

func (*AlgorithmSpecification) Descriptor() ([]byte, []int)

func (*AlgorithmSpecification) GetAlgorithmName

func (m *AlgorithmSpecification) GetAlgorithmName() AlgorithmName_Value

func (*AlgorithmSpecification) GetAlgorithmVersion

func (m *AlgorithmSpecification) GetAlgorithmVersion() string

func (*AlgorithmSpecification) GetInputContentType

func (m *AlgorithmSpecification) GetInputContentType() InputContentType_Value

func (*AlgorithmSpecification) GetInputMode

func (m *AlgorithmSpecification) GetInputMode() InputMode_Value

func (*AlgorithmSpecification) GetMetricDefinitions

func (m *AlgorithmSpecification) GetMetricDefinitions() []*MetricDefinition

func (*AlgorithmSpecification) ProtoMessage

func (*AlgorithmSpecification) ProtoMessage()

func (*AlgorithmSpecification) Reset

func (m *AlgorithmSpecification) Reset()

func (*AlgorithmSpecification) String

func (m *AlgorithmSpecification) String() string

func (*AlgorithmSpecification) Validate

func (m *AlgorithmSpecification) Validate() error

Validate checks the field values on AlgorithmSpecification with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*AlgorithmSpecification) XXX_DiscardUnknown

func (m *AlgorithmSpecification) XXX_DiscardUnknown()

func (*AlgorithmSpecification) XXX_Marshal

func (m *AlgorithmSpecification) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AlgorithmSpecification) XXX_Merge

func (m *AlgorithmSpecification) XXX_Merge(src proto.Message)

func (*AlgorithmSpecification) XXX_Size

func (m *AlgorithmSpecification) XXX_Size() int

func (*AlgorithmSpecification) XXX_Unmarshal

func (m *AlgorithmSpecification) XXX_Unmarshal(b []byte) error

type AlgorithmSpecificationValidationError

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

AlgorithmSpecificationValidationError is the validation error returned by AlgorithmSpecification.Validate if the designated constraints aren't met.

func (AlgorithmSpecificationValidationError) Cause

Cause function returns cause value.

func (AlgorithmSpecificationValidationError) Error

Error satisfies the builtin error interface

func (AlgorithmSpecificationValidationError) ErrorName

ErrorName returns error name.

func (AlgorithmSpecificationValidationError) Field

Field function returns field value.

func (AlgorithmSpecificationValidationError) Key

Key function returns key value.

func (AlgorithmSpecificationValidationError) Reason

Reason function returns reason value.

type CategoricalParameterRange

type CategoricalParameterRange struct {
	Values               []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ContinuousParameterRange refers to a continuous range of hyperparameter values, allowing users to specify the search space of a floating-point hyperparameter https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html

func (*CategoricalParameterRange) Descriptor

func (*CategoricalParameterRange) Descriptor() ([]byte, []int)

func (*CategoricalParameterRange) GetValues

func (m *CategoricalParameterRange) GetValues() []string

func (*CategoricalParameterRange) ProtoMessage

func (*CategoricalParameterRange) ProtoMessage()

func (*CategoricalParameterRange) Reset

func (m *CategoricalParameterRange) Reset()

func (*CategoricalParameterRange) String

func (m *CategoricalParameterRange) String() string

func (*CategoricalParameterRange) Validate

func (m *CategoricalParameterRange) Validate() error

Validate checks the field values on CategoricalParameterRange with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*CategoricalParameterRange) XXX_DiscardUnknown

func (m *CategoricalParameterRange) XXX_DiscardUnknown()

func (*CategoricalParameterRange) XXX_Marshal

func (m *CategoricalParameterRange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CategoricalParameterRange) XXX_Merge

func (m *CategoricalParameterRange) XXX_Merge(src proto.Message)

func (*CategoricalParameterRange) XXX_Size

func (m *CategoricalParameterRange) XXX_Size() int

func (*CategoricalParameterRange) XXX_Unmarshal

func (m *CategoricalParameterRange) XXX_Unmarshal(b []byte) error

type CategoricalParameterRangeValidationError

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

CategoricalParameterRangeValidationError is the validation error returned by CategoricalParameterRange.Validate if the designated constraints aren't met.

func (CategoricalParameterRangeValidationError) Cause

Cause function returns cause value.

func (CategoricalParameterRangeValidationError) Error

Error satisfies the builtin error interface

func (CategoricalParameterRangeValidationError) ErrorName

ErrorName returns error name.

func (CategoricalParameterRangeValidationError) Field

Field function returns field value.

func (CategoricalParameterRangeValidationError) Key

Key function returns key value.

func (CategoricalParameterRangeValidationError) Reason

Reason function returns reason value.

type ContinuousParameterRange

type ContinuousParameterRange struct {
	MaxValue             float64                         `protobuf:"fixed64,1,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	MinValue             float64                         `protobuf:"fixed64,2,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	ScalingType          HyperparameterScalingType_Value `` /* 159-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                        `json:"-"`
	XXX_unrecognized     []byte                          `json:"-"`
	XXX_sizecache        int32                           `json:"-"`
}

ContinuousParameterRange refers to a continuous range of hyperparameter values, allowing users to specify the search space of a floating-point hyperparameter https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html

func (*ContinuousParameterRange) Descriptor

func (*ContinuousParameterRange) Descriptor() ([]byte, []int)

func (*ContinuousParameterRange) GetMaxValue

func (m *ContinuousParameterRange) GetMaxValue() float64

func (*ContinuousParameterRange) GetMinValue

func (m *ContinuousParameterRange) GetMinValue() float64

func (*ContinuousParameterRange) GetScalingType

func (*ContinuousParameterRange) ProtoMessage

func (*ContinuousParameterRange) ProtoMessage()

func (*ContinuousParameterRange) Reset

func (m *ContinuousParameterRange) Reset()

func (*ContinuousParameterRange) String

func (m *ContinuousParameterRange) String() string

func (*ContinuousParameterRange) Validate

func (m *ContinuousParameterRange) Validate() error

Validate checks the field values on ContinuousParameterRange with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*ContinuousParameterRange) XXX_DiscardUnknown

func (m *ContinuousParameterRange) XXX_DiscardUnknown()

func (*ContinuousParameterRange) XXX_Marshal

func (m *ContinuousParameterRange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ContinuousParameterRange) XXX_Merge

func (m *ContinuousParameterRange) XXX_Merge(src proto.Message)

func (*ContinuousParameterRange) XXX_Size

func (m *ContinuousParameterRange) XXX_Size() int

func (*ContinuousParameterRange) XXX_Unmarshal

func (m *ContinuousParameterRange) XXX_Unmarshal(b []byte) error

type ContinuousParameterRangeValidationError

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

ContinuousParameterRangeValidationError is the validation error returned by ContinuousParameterRange.Validate if the designated constraints aren't met.

func (ContinuousParameterRangeValidationError) Cause

Cause function returns cause value.

func (ContinuousParameterRangeValidationError) Error

Error satisfies the builtin error interface

func (ContinuousParameterRangeValidationError) ErrorName

ErrorName returns error name.

func (ContinuousParameterRangeValidationError) Field

Field function returns field value.

func (ContinuousParameterRangeValidationError) Key

Key function returns key value.

func (ContinuousParameterRangeValidationError) Reason

Reason function returns reason value.

type DistributedProtocol added in v0.18.9

type DistributedProtocol struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

When enabling distributed training on a training job, the user should use this message to tell Flyte and SageMaker what kind of distributed protocol he/she wants to use to distribute the work.

func (*DistributedProtocol) Descriptor added in v0.18.9

func (*DistributedProtocol) Descriptor() ([]byte, []int)

func (*DistributedProtocol) ProtoMessage added in v0.18.9

func (*DistributedProtocol) ProtoMessage()

func (*DistributedProtocol) Reset added in v0.18.9

func (m *DistributedProtocol) Reset()

func (*DistributedProtocol) String added in v0.18.9

func (m *DistributedProtocol) String() string

func (*DistributedProtocol) Validate added in v0.18.9

func (m *DistributedProtocol) Validate() error

Validate checks the field values on DistributedProtocol with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*DistributedProtocol) XXX_DiscardUnknown added in v0.18.9

func (m *DistributedProtocol) XXX_DiscardUnknown()

func (*DistributedProtocol) XXX_Marshal added in v0.18.9

func (m *DistributedProtocol) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DistributedProtocol) XXX_Merge added in v0.18.9

func (m *DistributedProtocol) XXX_Merge(src proto.Message)

func (*DistributedProtocol) XXX_Size added in v0.18.9

func (m *DistributedProtocol) XXX_Size() int

func (*DistributedProtocol) XXX_Unmarshal added in v0.18.9

func (m *DistributedProtocol) XXX_Unmarshal(b []byte) error

type DistributedProtocolValidationError added in v0.18.9

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

DistributedProtocolValidationError is the validation error returned by DistributedProtocol.Validate if the designated constraints aren't met.

func (DistributedProtocolValidationError) Cause added in v0.18.9

Cause function returns cause value.

func (DistributedProtocolValidationError) Error added in v0.18.9

Error satisfies the builtin error interface

func (DistributedProtocolValidationError) ErrorName added in v0.18.9

ErrorName returns error name.

func (DistributedProtocolValidationError) Field added in v0.18.9

Field function returns field value.

func (DistributedProtocolValidationError) Key added in v0.18.9

Key function returns key value.

func (DistributedProtocolValidationError) Reason added in v0.18.9

Reason function returns reason value.

type DistributedProtocol_Value added in v0.18.9

type DistributedProtocol_Value int32
const (
	// Use this value if the user wishes to use framework-native distributed training interfaces.
	// If this value is used, Flyte won't configure SageMaker to initialize unnecessary components such as
	// OpenMPI or Parameter Server.
	DistributedProtocol_UNSPECIFIED DistributedProtocol_Value = 0
	// Use this value if the user wishes to use MPI as the underlying protocol for her distributed training job
	// MPI is a framework-agnostic distributed protocol. It has multiple implementations. Currently, we have only
	// tested the OpenMPI implementation, which is the recommended implementation for Horovod.
	DistributedProtocol_MPI DistributedProtocol_Value = 1
)

func (DistributedProtocol_Value) EnumDescriptor added in v0.18.9

func (DistributedProtocol_Value) EnumDescriptor() ([]byte, []int)

func (DistributedProtocol_Value) String added in v0.18.9

func (x DistributedProtocol_Value) String() string

type HyperparameterScalingType

type HyperparameterScalingType struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

HyperparameterScalingType defines the way to increase or decrease the value of the hyperparameter For details, refer to: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html See examples of these scaling type, refer to: https://aws.amazon.com/blogs/machine-learning/amazon-sagemaker-automatic-model-tuning-now-supports-random-search-and-hyperparameter-scaling/

func (*HyperparameterScalingType) Descriptor

func (*HyperparameterScalingType) Descriptor() ([]byte, []int)

func (*HyperparameterScalingType) ProtoMessage

func (*HyperparameterScalingType) ProtoMessage()

func (*HyperparameterScalingType) Reset

func (m *HyperparameterScalingType) Reset()

func (*HyperparameterScalingType) String

func (m *HyperparameterScalingType) String() string

func (*HyperparameterScalingType) Validate

func (m *HyperparameterScalingType) Validate() error

Validate checks the field values on HyperparameterScalingType with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterScalingType) XXX_DiscardUnknown

func (m *HyperparameterScalingType) XXX_DiscardUnknown()

func (*HyperparameterScalingType) XXX_Marshal

func (m *HyperparameterScalingType) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterScalingType) XXX_Merge

func (m *HyperparameterScalingType) XXX_Merge(src proto.Message)

func (*HyperparameterScalingType) XXX_Size

func (m *HyperparameterScalingType) XXX_Size() int

func (*HyperparameterScalingType) XXX_Unmarshal

func (m *HyperparameterScalingType) XXX_Unmarshal(b []byte) error

type HyperparameterScalingTypeValidationError

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

HyperparameterScalingTypeValidationError is the validation error returned by HyperparameterScalingType.Validate if the designated constraints aren't met.

func (HyperparameterScalingTypeValidationError) Cause

Cause function returns cause value.

func (HyperparameterScalingTypeValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterScalingTypeValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterScalingTypeValidationError) Field

Field function returns field value.

func (HyperparameterScalingTypeValidationError) Key

Key function returns key value.

func (HyperparameterScalingTypeValidationError) Reason

Reason function returns reason value.

type HyperparameterScalingType_Value

type HyperparameterScalingType_Value int32
const (
	HyperparameterScalingType_AUTO               HyperparameterScalingType_Value = 0
	HyperparameterScalingType_LINEAR             HyperparameterScalingType_Value = 1
	HyperparameterScalingType_LOGARITHMIC        HyperparameterScalingType_Value = 2
	HyperparameterScalingType_REVERSELOGARITHMIC HyperparameterScalingType_Value = 3
)

func (HyperparameterScalingType_Value) EnumDescriptor

func (HyperparameterScalingType_Value) EnumDescriptor() ([]byte, []int)

func (HyperparameterScalingType_Value) String

type HyperparameterTuningJob

type HyperparameterTuningJob struct {
	// The underlying training job that the hyperparameter tuning job will launch during the process
	TrainingJob *TrainingJob `protobuf:"bytes,1,opt,name=training_job,json=trainingJob,proto3" json:"training_job,omitempty"`
	// The maximum number of training jobs that an hpo job can launch. For resource limit purpose.
	// https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html
	MaxNumberOfTrainingJobs int64 `` /* 137-byte string literal not displayed */
	// The maximum number of concurrent training job that an hpo job can launch
	// https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html
	MaxParallelTrainingJobs int64    `` /* 135-byte string literal not displayed */
	XXX_NoUnkeyedLiteral    struct{} `json:"-"`
	XXX_unrecognized        []byte   `json:"-"`
	XXX_sizecache           int32    `json:"-"`
}

A pass-through for SageMaker's hyperparameter tuning job

func (*HyperparameterTuningJob) Descriptor

func (*HyperparameterTuningJob) Descriptor() ([]byte, []int)

func (*HyperparameterTuningJob) GetMaxNumberOfTrainingJobs

func (m *HyperparameterTuningJob) GetMaxNumberOfTrainingJobs() int64

func (*HyperparameterTuningJob) GetMaxParallelTrainingJobs

func (m *HyperparameterTuningJob) GetMaxParallelTrainingJobs() int64

func (*HyperparameterTuningJob) GetTrainingJob

func (m *HyperparameterTuningJob) GetTrainingJob() *TrainingJob

func (*HyperparameterTuningJob) ProtoMessage

func (*HyperparameterTuningJob) ProtoMessage()

func (*HyperparameterTuningJob) Reset

func (m *HyperparameterTuningJob) Reset()

func (*HyperparameterTuningJob) String

func (m *HyperparameterTuningJob) String() string

func (*HyperparameterTuningJob) Validate

func (m *HyperparameterTuningJob) Validate() error

Validate checks the field values on HyperparameterTuningJob with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterTuningJob) XXX_DiscardUnknown

func (m *HyperparameterTuningJob) XXX_DiscardUnknown()

func (*HyperparameterTuningJob) XXX_Marshal

func (m *HyperparameterTuningJob) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterTuningJob) XXX_Merge

func (m *HyperparameterTuningJob) XXX_Merge(src proto.Message)

func (*HyperparameterTuningJob) XXX_Size

func (m *HyperparameterTuningJob) XXX_Size() int

func (*HyperparameterTuningJob) XXX_Unmarshal

func (m *HyperparameterTuningJob) XXX_Unmarshal(b []byte) error

type HyperparameterTuningJobConfig

type HyperparameterTuningJobConfig struct {
	// ParameterRanges is a map that maps hyperparameter name to the corresponding hyperparameter range
	HyperparameterRanges *ParameterRanges `protobuf:"bytes,1,opt,name=hyperparameter_ranges,json=hyperparameterRanges,proto3" json:"hyperparameter_ranges,omitempty"`
	// Setting the strategy used when searching in the hyperparameter space
	TuningStrategy HyperparameterTuningStrategy_Value `` /* 171-byte string literal not displayed */
	// The target metric and the objective of the hyperparameter tuning.
	TuningObjective *HyperparameterTuningObjective `protobuf:"bytes,3,opt,name=tuning_objective,json=tuningObjective,proto3" json:"tuning_objective,omitempty"`
	// When the training jobs launched by the hyperparameter tuning job are not improving significantly,
	// a hyperparameter tuning job can be stopping early.
	TrainingJobEarlyStoppingType TrainingJobEarlyStoppingType_Value `` /* 219-byte string literal not displayed */
	XXX_NoUnkeyedLiteral         struct{}                           `json:"-"`
	XXX_unrecognized             []byte                             `json:"-"`
	XXX_sizecache                int32                              `json:"-"`
}

The specification of the hyperparameter tuning process https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-ex-tuning-job.html#automatic-model-tuning-ex-low-tuning-config

func (*HyperparameterTuningJobConfig) Descriptor

func (*HyperparameterTuningJobConfig) Descriptor() ([]byte, []int)

func (*HyperparameterTuningJobConfig) GetHyperparameterRanges

func (m *HyperparameterTuningJobConfig) GetHyperparameterRanges() *ParameterRanges

func (*HyperparameterTuningJobConfig) GetTrainingJobEarlyStoppingType

func (m *HyperparameterTuningJobConfig) GetTrainingJobEarlyStoppingType() TrainingJobEarlyStoppingType_Value

func (*HyperparameterTuningJobConfig) GetTuningObjective

func (*HyperparameterTuningJobConfig) GetTuningStrategy

func (*HyperparameterTuningJobConfig) ProtoMessage

func (*HyperparameterTuningJobConfig) ProtoMessage()

func (*HyperparameterTuningJobConfig) Reset

func (m *HyperparameterTuningJobConfig) Reset()

func (*HyperparameterTuningJobConfig) String

func (*HyperparameterTuningJobConfig) Validate

func (m *HyperparameterTuningJobConfig) Validate() error

Validate checks the field values on HyperparameterTuningJobConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterTuningJobConfig) XXX_DiscardUnknown

func (m *HyperparameterTuningJobConfig) XXX_DiscardUnknown()

func (*HyperparameterTuningJobConfig) XXX_Marshal

func (m *HyperparameterTuningJobConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterTuningJobConfig) XXX_Merge

func (m *HyperparameterTuningJobConfig) XXX_Merge(src proto.Message)

func (*HyperparameterTuningJobConfig) XXX_Size

func (m *HyperparameterTuningJobConfig) XXX_Size() int

func (*HyperparameterTuningJobConfig) XXX_Unmarshal

func (m *HyperparameterTuningJobConfig) XXX_Unmarshal(b []byte) error

type HyperparameterTuningJobConfigValidationError

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

HyperparameterTuningJobConfigValidationError is the validation error returned by HyperparameterTuningJobConfig.Validate if the designated constraints aren't met.

func (HyperparameterTuningJobConfigValidationError) Cause

Cause function returns cause value.

func (HyperparameterTuningJobConfigValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterTuningJobConfigValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterTuningJobConfigValidationError) Field

Field function returns field value.

func (HyperparameterTuningJobConfigValidationError) Key

Key function returns key value.

func (HyperparameterTuningJobConfigValidationError) Reason

Reason function returns reason value.

type HyperparameterTuningJobValidationError

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

HyperparameterTuningJobValidationError is the validation error returned by HyperparameterTuningJob.Validate if the designated constraints aren't met.

func (HyperparameterTuningJobValidationError) Cause

Cause function returns cause value.

func (HyperparameterTuningJobValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterTuningJobValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterTuningJobValidationError) Field

Field function returns field value.

func (HyperparameterTuningJobValidationError) Key

Key function returns key value.

func (HyperparameterTuningJobValidationError) Reason

Reason function returns reason value.

type HyperparameterTuningObjective

type HyperparameterTuningObjective struct {
	// HyperparameterTuningObjectiveType determines the direction of the tuning of the Hyperparameter Tuning Job
	// with respect to the specified metric.
	ObjectiveType HyperparameterTuningObjectiveType_Value `` /* 173-byte string literal not displayed */
	// The target metric name, which is the user-defined name of the metric specified in the
	// training job's algorithm specification
	MetricName           string   `protobuf:"bytes,2,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The target metric and the objective of the hyperparameter tuning. https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html

func (*HyperparameterTuningObjective) Descriptor

func (*HyperparameterTuningObjective) Descriptor() ([]byte, []int)

func (*HyperparameterTuningObjective) GetMetricName

func (m *HyperparameterTuningObjective) GetMetricName() string

func (*HyperparameterTuningObjective) GetObjectiveType

func (*HyperparameterTuningObjective) ProtoMessage

func (*HyperparameterTuningObjective) ProtoMessage()

func (*HyperparameterTuningObjective) Reset

func (m *HyperparameterTuningObjective) Reset()

func (*HyperparameterTuningObjective) String

func (*HyperparameterTuningObjective) Validate

func (m *HyperparameterTuningObjective) Validate() error

Validate checks the field values on HyperparameterTuningObjective with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterTuningObjective) XXX_DiscardUnknown

func (m *HyperparameterTuningObjective) XXX_DiscardUnknown()

func (*HyperparameterTuningObjective) XXX_Marshal

func (m *HyperparameterTuningObjective) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterTuningObjective) XXX_Merge

func (m *HyperparameterTuningObjective) XXX_Merge(src proto.Message)

func (*HyperparameterTuningObjective) XXX_Size

func (m *HyperparameterTuningObjective) XXX_Size() int

func (*HyperparameterTuningObjective) XXX_Unmarshal

func (m *HyperparameterTuningObjective) XXX_Unmarshal(b []byte) error

type HyperparameterTuningObjectiveType

type HyperparameterTuningObjectiveType struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

HyperparameterTuningObjectiveType determines the direction of the tuning of the Hyperparameter Tuning Job with respect to the specified metric.

func (*HyperparameterTuningObjectiveType) Descriptor

func (*HyperparameterTuningObjectiveType) Descriptor() ([]byte, []int)

func (*HyperparameterTuningObjectiveType) ProtoMessage

func (*HyperparameterTuningObjectiveType) ProtoMessage()

func (*HyperparameterTuningObjectiveType) Reset

func (*HyperparameterTuningObjectiveType) String

func (*HyperparameterTuningObjectiveType) Validate

Validate checks the field values on HyperparameterTuningObjectiveType with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterTuningObjectiveType) XXX_DiscardUnknown

func (m *HyperparameterTuningObjectiveType) XXX_DiscardUnknown()

func (*HyperparameterTuningObjectiveType) XXX_Marshal

func (m *HyperparameterTuningObjectiveType) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterTuningObjectiveType) XXX_Merge

func (*HyperparameterTuningObjectiveType) XXX_Size

func (m *HyperparameterTuningObjectiveType) XXX_Size() int

func (*HyperparameterTuningObjectiveType) XXX_Unmarshal

func (m *HyperparameterTuningObjectiveType) XXX_Unmarshal(b []byte) error

type HyperparameterTuningObjectiveTypeValidationError

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

HyperparameterTuningObjectiveTypeValidationError is the validation error returned by HyperparameterTuningObjectiveType.Validate if the designated constraints aren't met.

func (HyperparameterTuningObjectiveTypeValidationError) Cause

Cause function returns cause value.

func (HyperparameterTuningObjectiveTypeValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterTuningObjectiveTypeValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterTuningObjectiveTypeValidationError) Field

Field function returns field value.

func (HyperparameterTuningObjectiveTypeValidationError) Key

Key function returns key value.

func (HyperparameterTuningObjectiveTypeValidationError) Reason

Reason function returns reason value.

type HyperparameterTuningObjectiveType_Value

type HyperparameterTuningObjectiveType_Value int32
const (
	HyperparameterTuningObjectiveType_MINIMIZE HyperparameterTuningObjectiveType_Value = 0
	HyperparameterTuningObjectiveType_MAXIMIZE HyperparameterTuningObjectiveType_Value = 1
)

func (HyperparameterTuningObjectiveType_Value) EnumDescriptor

func (HyperparameterTuningObjectiveType_Value) EnumDescriptor() ([]byte, []int)

func (HyperparameterTuningObjectiveType_Value) String

type HyperparameterTuningObjectiveValidationError

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

HyperparameterTuningObjectiveValidationError is the validation error returned by HyperparameterTuningObjective.Validate if the designated constraints aren't met.

func (HyperparameterTuningObjectiveValidationError) Cause

Cause function returns cause value.

func (HyperparameterTuningObjectiveValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterTuningObjectiveValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterTuningObjectiveValidationError) Field

Field function returns field value.

func (HyperparameterTuningObjectiveValidationError) Key

Key function returns key value.

func (HyperparameterTuningObjectiveValidationError) Reason

Reason function returns reason value.

type HyperparameterTuningStrategy

type HyperparameterTuningStrategy struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Setting the strategy used when searching in the hyperparameter space Refer this doc for more details: https://aws.amazon.com/blogs/machine-learning/amazon-sagemaker-automatic-model-tuning-now-supports-random-search-and-hyperparameter-scaling/

func (*HyperparameterTuningStrategy) Descriptor

func (*HyperparameterTuningStrategy) Descriptor() ([]byte, []int)

func (*HyperparameterTuningStrategy) ProtoMessage

func (*HyperparameterTuningStrategy) ProtoMessage()

func (*HyperparameterTuningStrategy) Reset

func (m *HyperparameterTuningStrategy) Reset()

func (*HyperparameterTuningStrategy) String

func (*HyperparameterTuningStrategy) Validate

func (m *HyperparameterTuningStrategy) Validate() error

Validate checks the field values on HyperparameterTuningStrategy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*HyperparameterTuningStrategy) XXX_DiscardUnknown

func (m *HyperparameterTuningStrategy) XXX_DiscardUnknown()

func (*HyperparameterTuningStrategy) XXX_Marshal

func (m *HyperparameterTuningStrategy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HyperparameterTuningStrategy) XXX_Merge

func (m *HyperparameterTuningStrategy) XXX_Merge(src proto.Message)

func (*HyperparameterTuningStrategy) XXX_Size

func (m *HyperparameterTuningStrategy) XXX_Size() int

func (*HyperparameterTuningStrategy) XXX_Unmarshal

func (m *HyperparameterTuningStrategy) XXX_Unmarshal(b []byte) error

type HyperparameterTuningStrategyValidationError

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

HyperparameterTuningStrategyValidationError is the validation error returned by HyperparameterTuningStrategy.Validate if the designated constraints aren't met.

func (HyperparameterTuningStrategyValidationError) Cause

Cause function returns cause value.

func (HyperparameterTuningStrategyValidationError) Error

Error satisfies the builtin error interface

func (HyperparameterTuningStrategyValidationError) ErrorName

ErrorName returns error name.

func (HyperparameterTuningStrategyValidationError) Field

Field function returns field value.

func (HyperparameterTuningStrategyValidationError) Key

Key function returns key value.

func (HyperparameterTuningStrategyValidationError) Reason

Reason function returns reason value.

type HyperparameterTuningStrategy_Value

type HyperparameterTuningStrategy_Value int32
const (
	HyperparameterTuningStrategy_BAYESIAN HyperparameterTuningStrategy_Value = 0
	HyperparameterTuningStrategy_RANDOM   HyperparameterTuningStrategy_Value = 1
)

func (HyperparameterTuningStrategy_Value) EnumDescriptor

func (HyperparameterTuningStrategy_Value) EnumDescriptor() ([]byte, []int)

func (HyperparameterTuningStrategy_Value) String

type InputContentType

type InputContentType struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Specifies the type of file for input data. Different SageMaker built-in algorithms require different file types of input data See https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-training.html https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html

func (*InputContentType) Descriptor

func (*InputContentType) Descriptor() ([]byte, []int)

func (*InputContentType) ProtoMessage

func (*InputContentType) ProtoMessage()

func (*InputContentType) Reset

func (m *InputContentType) Reset()

func (*InputContentType) String

func (m *InputContentType) String() string

func (*InputContentType) Validate

func (m *InputContentType) Validate() error

Validate checks the field values on InputContentType with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*InputContentType) XXX_DiscardUnknown

func (m *InputContentType) XXX_DiscardUnknown()

func (*InputContentType) XXX_Marshal

func (m *InputContentType) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InputContentType) XXX_Merge

func (m *InputContentType) XXX_Merge(src proto.Message)

func (*InputContentType) XXX_Size

func (m *InputContentType) XXX_Size() int

func (*InputContentType) XXX_Unmarshal

func (m *InputContentType) XXX_Unmarshal(b []byte) error

type InputContentTypeValidationError

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

InputContentTypeValidationError is the validation error returned by InputContentType.Validate if the designated constraints aren't met.

func (InputContentTypeValidationError) Cause

Cause function returns cause value.

func (InputContentTypeValidationError) Error

Error satisfies the builtin error interface

func (InputContentTypeValidationError) ErrorName

ErrorName returns error name.

func (InputContentTypeValidationError) Field

Field function returns field value.

func (InputContentTypeValidationError) Key

Key function returns key value.

func (InputContentTypeValidationError) Reason

Reason function returns reason value.

type InputContentType_Value

type InputContentType_Value int32
const (
	InputContentType_TEXT_CSV InputContentType_Value = 0
)

func (InputContentType_Value) EnumDescriptor

func (InputContentType_Value) EnumDescriptor() ([]byte, []int)

func (InputContentType_Value) String

func (x InputContentType_Value) String() string

type InputMode

type InputMode struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The input mode that the algorithm supports. When using the File input mode, SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. When using Pipe input mode, Amazon SageMaker streams data directly from S3 to the container. See: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html For the input modes that different SageMaker algorithms support, see: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html

func (*InputMode) Descriptor

func (*InputMode) Descriptor() ([]byte, []int)

func (*InputMode) ProtoMessage

func (*InputMode) ProtoMessage()

func (*InputMode) Reset

func (m *InputMode) Reset()

func (*InputMode) String

func (m *InputMode) String() string

func (*InputMode) Validate

func (m *InputMode) Validate() error

Validate checks the field values on InputMode with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*InputMode) XXX_DiscardUnknown

func (m *InputMode) XXX_DiscardUnknown()

func (*InputMode) XXX_Marshal

func (m *InputMode) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InputMode) XXX_Merge

func (m *InputMode) XXX_Merge(src proto.Message)

func (*InputMode) XXX_Size

func (m *InputMode) XXX_Size() int

func (*InputMode) XXX_Unmarshal

func (m *InputMode) XXX_Unmarshal(b []byte) error

type InputModeValidationError

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

InputModeValidationError is the validation error returned by InputMode.Validate if the designated constraints aren't met.

func (InputModeValidationError) Cause

func (e InputModeValidationError) Cause() error

Cause function returns cause value.

func (InputModeValidationError) Error

func (e InputModeValidationError) Error() string

Error satisfies the builtin error interface

func (InputModeValidationError) ErrorName

func (e InputModeValidationError) ErrorName() string

ErrorName returns error name.

func (InputModeValidationError) Field

func (e InputModeValidationError) Field() string

Field function returns field value.

func (InputModeValidationError) Key

Key function returns key value.

func (InputModeValidationError) Reason

func (e InputModeValidationError) Reason() string

Reason function returns reason value.

type InputMode_Value

type InputMode_Value int32
const (
	InputMode_FILE InputMode_Value = 0
	InputMode_PIPE InputMode_Value = 1
)

func (InputMode_Value) EnumDescriptor

func (InputMode_Value) EnumDescriptor() ([]byte, []int)

func (InputMode_Value) String

func (x InputMode_Value) String() string

type IntegerParameterRange

type IntegerParameterRange struct {
	MaxValue             int64                           `protobuf:"varint,1,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	MinValue             int64                           `protobuf:"varint,2,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	ScalingType          HyperparameterScalingType_Value `` /* 159-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                        `json:"-"`
	XXX_unrecognized     []byte                          `json:"-"`
	XXX_sizecache        int32                           `json:"-"`
}

IntegerParameterRange refers to a discrete range of hyperparameter values, allowing users to specify the search space of an integer hyperparameter https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html

func (*IntegerParameterRange) Descriptor

func (*IntegerParameterRange) Descriptor() ([]byte, []int)

func (*IntegerParameterRange) GetMaxValue

func (m *IntegerParameterRange) GetMaxValue() int64

func (*IntegerParameterRange) GetMinValue

func (m *IntegerParameterRange) GetMinValue() int64

func (*IntegerParameterRange) GetScalingType

func (*IntegerParameterRange) ProtoMessage

func (*IntegerParameterRange) ProtoMessage()

func (*IntegerParameterRange) Reset

func (m *IntegerParameterRange) Reset()

func (*IntegerParameterRange) String

func (m *IntegerParameterRange) String() string

func (*IntegerParameterRange) Validate

func (m *IntegerParameterRange) Validate() error

Validate checks the field values on IntegerParameterRange with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*IntegerParameterRange) XXX_DiscardUnknown

func (m *IntegerParameterRange) XXX_DiscardUnknown()

func (*IntegerParameterRange) XXX_Marshal

func (m *IntegerParameterRange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IntegerParameterRange) XXX_Merge

func (m *IntegerParameterRange) XXX_Merge(src proto.Message)

func (*IntegerParameterRange) XXX_Size

func (m *IntegerParameterRange) XXX_Size() int

func (*IntegerParameterRange) XXX_Unmarshal

func (m *IntegerParameterRange) XXX_Unmarshal(b []byte) error

type IntegerParameterRangeValidationError

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

IntegerParameterRangeValidationError is the validation error returned by IntegerParameterRange.Validate if the designated constraints aren't met.

func (IntegerParameterRangeValidationError) Cause

Cause function returns cause value.

func (IntegerParameterRangeValidationError) Error

Error satisfies the builtin error interface

func (IntegerParameterRangeValidationError) ErrorName

ErrorName returns error name.

func (IntegerParameterRangeValidationError) Field

Field function returns field value.

func (IntegerParameterRangeValidationError) Key

Key function returns key value.

func (IntegerParameterRangeValidationError) Reason

Reason function returns reason value.

type MetricDefinition

type MetricDefinition struct {
	// User-defined name of the metric
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// SageMaker hyperparameter tuning parses your algorithm’s stdout and stderr streams to find algorithm metrics
	Regex                string   `protobuf:"bytes,2,opt,name=regex,proto3" json:"regex,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Specifies a metric that the training algorithm writes to stderr or stdout. This object is a pass-through. See this for details: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html

func (*MetricDefinition) Descriptor

func (*MetricDefinition) Descriptor() ([]byte, []int)

func (*MetricDefinition) GetName

func (m *MetricDefinition) GetName() string

func (*MetricDefinition) GetRegex

func (m *MetricDefinition) GetRegex() string

func (*MetricDefinition) ProtoMessage

func (*MetricDefinition) ProtoMessage()

func (*MetricDefinition) Reset

func (m *MetricDefinition) Reset()

func (*MetricDefinition) String

func (m *MetricDefinition) String() string

func (*MetricDefinition) Validate

func (m *MetricDefinition) Validate() error

Validate checks the field values on MetricDefinition with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*MetricDefinition) XXX_DiscardUnknown

func (m *MetricDefinition) XXX_DiscardUnknown()

func (*MetricDefinition) XXX_Marshal

func (m *MetricDefinition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetricDefinition) XXX_Merge

func (m *MetricDefinition) XXX_Merge(src proto.Message)

func (*MetricDefinition) XXX_Size

func (m *MetricDefinition) XXX_Size() int

func (*MetricDefinition) XXX_Unmarshal

func (m *MetricDefinition) XXX_Unmarshal(b []byte) error

type MetricDefinitionValidationError

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

MetricDefinitionValidationError is the validation error returned by MetricDefinition.Validate if the designated constraints aren't met.

func (MetricDefinitionValidationError) Cause

Cause function returns cause value.

func (MetricDefinitionValidationError) Error

Error satisfies the builtin error interface

func (MetricDefinitionValidationError) ErrorName

ErrorName returns error name.

func (MetricDefinitionValidationError) Field

Field function returns field value.

func (MetricDefinitionValidationError) Key

Key function returns key value.

func (MetricDefinitionValidationError) Reason

Reason function returns reason value.

type ParameterRangeOneOf

type ParameterRangeOneOf struct {
	// Types that are valid to be assigned to ParameterRangeType:
	//	*ParameterRangeOneOf_ContinuousParameterRange
	//	*ParameterRangeOneOf_IntegerParameterRange
	//	*ParameterRangeOneOf_CategoricalParameterRange
	ParameterRangeType   isParameterRangeOneOf_ParameterRangeType `protobuf_oneof:"parameter_range_type"`
	XXX_NoUnkeyedLiteral struct{}                                 `json:"-"`
	XXX_unrecognized     []byte                                   `json:"-"`
	XXX_sizecache        int32                                    `json:"-"`
}

ParameterRangeOneOf describes a single ParameterRange, which is a one-of structure that can be one of the three possible types: ContinuousParameterRange, IntegerParameterRange, and CategoricalParameterRange. This one-of structure in Flyte enables specifying a Parameter in a type-safe manner See: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html

func (*ParameterRangeOneOf) Descriptor

func (*ParameterRangeOneOf) Descriptor() ([]byte, []int)

func (*ParameterRangeOneOf) GetCategoricalParameterRange

func (m *ParameterRangeOneOf) GetCategoricalParameterRange() *CategoricalParameterRange

func (*ParameterRangeOneOf) GetContinuousParameterRange

func (m *ParameterRangeOneOf) GetContinuousParameterRange() *ContinuousParameterRange

func (*ParameterRangeOneOf) GetIntegerParameterRange

func (m *ParameterRangeOneOf) GetIntegerParameterRange() *IntegerParameterRange

func (*ParameterRangeOneOf) GetParameterRangeType

func (m *ParameterRangeOneOf) GetParameterRangeType() isParameterRangeOneOf_ParameterRangeType

func (*ParameterRangeOneOf) ProtoMessage

func (*ParameterRangeOneOf) ProtoMessage()

func (*ParameterRangeOneOf) Reset

func (m *ParameterRangeOneOf) Reset()

func (*ParameterRangeOneOf) String

func (m *ParameterRangeOneOf) String() string

func (*ParameterRangeOneOf) Validate

func (m *ParameterRangeOneOf) Validate() error

Validate checks the field values on ParameterRangeOneOf with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*ParameterRangeOneOf) XXX_DiscardUnknown

func (m *ParameterRangeOneOf) XXX_DiscardUnknown()

func (*ParameterRangeOneOf) XXX_Marshal

func (m *ParameterRangeOneOf) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ParameterRangeOneOf) XXX_Merge

func (m *ParameterRangeOneOf) XXX_Merge(src proto.Message)

func (*ParameterRangeOneOf) XXX_OneofWrappers

func (*ParameterRangeOneOf) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ParameterRangeOneOf) XXX_Size

func (m *ParameterRangeOneOf) XXX_Size() int

func (*ParameterRangeOneOf) XXX_Unmarshal

func (m *ParameterRangeOneOf) XXX_Unmarshal(b []byte) error

type ParameterRangeOneOfValidationError

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

ParameterRangeOneOfValidationError is the validation error returned by ParameterRangeOneOf.Validate if the designated constraints aren't met.

func (ParameterRangeOneOfValidationError) Cause

Cause function returns cause value.

func (ParameterRangeOneOfValidationError) Error

Error satisfies the builtin error interface

func (ParameterRangeOneOfValidationError) ErrorName

ErrorName returns error name.

func (ParameterRangeOneOfValidationError) Field

Field function returns field value.

func (ParameterRangeOneOfValidationError) Key

Key function returns key value.

func (ParameterRangeOneOfValidationError) Reason

Reason function returns reason value.

type ParameterRangeOneOf_CategoricalParameterRange

type ParameterRangeOneOf_CategoricalParameterRange struct {
	CategoricalParameterRange *CategoricalParameterRange `protobuf:"bytes,3,opt,name=categorical_parameter_range,json=categoricalParameterRange,proto3,oneof"`
}

type ParameterRangeOneOf_ContinuousParameterRange

type ParameterRangeOneOf_ContinuousParameterRange struct {
	ContinuousParameterRange *ContinuousParameterRange `protobuf:"bytes,1,opt,name=continuous_parameter_range,json=continuousParameterRange,proto3,oneof"`
}

type ParameterRangeOneOf_IntegerParameterRange

type ParameterRangeOneOf_IntegerParameterRange struct {
	IntegerParameterRange *IntegerParameterRange `protobuf:"bytes,2,opt,name=integer_parameter_range,json=integerParameterRange,proto3,oneof"`
}

type ParameterRanges

type ParameterRanges struct {
	ParameterRangeMap    map[string]*ParameterRangeOneOf `` /* 202-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                        `json:"-"`
	XXX_unrecognized     []byte                          `json:"-"`
	XXX_sizecache        int32                           `json:"-"`
}

ParameterRanges is a map that maps hyperparameter name to the corresponding hyperparameter range https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html

func (*ParameterRanges) Descriptor

func (*ParameterRanges) Descriptor() ([]byte, []int)

func (*ParameterRanges) GetParameterRangeMap

func (m *ParameterRanges) GetParameterRangeMap() map[string]*ParameterRangeOneOf

func (*ParameterRanges) ProtoMessage

func (*ParameterRanges) ProtoMessage()

func (*ParameterRanges) Reset

func (m *ParameterRanges) Reset()

func (*ParameterRanges) String

func (m *ParameterRanges) String() string

func (*ParameterRanges) Validate

func (m *ParameterRanges) Validate() error

Validate checks the field values on ParameterRanges with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*ParameterRanges) XXX_DiscardUnknown

func (m *ParameterRanges) XXX_DiscardUnknown()

func (*ParameterRanges) XXX_Marshal

func (m *ParameterRanges) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ParameterRanges) XXX_Merge

func (m *ParameterRanges) XXX_Merge(src proto.Message)

func (*ParameterRanges) XXX_Size

func (m *ParameterRanges) XXX_Size() int

func (*ParameterRanges) XXX_Unmarshal

func (m *ParameterRanges) XXX_Unmarshal(b []byte) error

type ParameterRangesValidationError

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

ParameterRangesValidationError is the validation error returned by ParameterRanges.Validate if the designated constraints aren't met.

func (ParameterRangesValidationError) Cause

Cause function returns cause value.

func (ParameterRangesValidationError) Error

Error satisfies the builtin error interface

func (ParameterRangesValidationError) ErrorName

func (e ParameterRangesValidationError) ErrorName() string

ErrorName returns error name.

func (ParameterRangesValidationError) Field

Field function returns field value.

func (ParameterRangesValidationError) Key

Key function returns key value.

func (ParameterRangesValidationError) Reason

Reason function returns reason value.

type TrainingJob

type TrainingJob struct {
	AlgorithmSpecification    *AlgorithmSpecification    `` /* 127-byte string literal not displayed */
	TrainingJobResourceConfig *TrainingJobResourceConfig `` /* 140-byte string literal not displayed */
	XXX_NoUnkeyedLiteral      struct{}                   `json:"-"`
	XXX_unrecognized          []byte                     `json:"-"`
	XXX_sizecache             int32                      `json:"-"`
}

The spec of a training job. This is mostly a pass-through object https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html

func (*TrainingJob) Descriptor

func (*TrainingJob) Descriptor() ([]byte, []int)

func (*TrainingJob) GetAlgorithmSpecification

func (m *TrainingJob) GetAlgorithmSpecification() *AlgorithmSpecification

func (*TrainingJob) GetTrainingJobResourceConfig

func (m *TrainingJob) GetTrainingJobResourceConfig() *TrainingJobResourceConfig

func (*TrainingJob) ProtoMessage

func (*TrainingJob) ProtoMessage()

func (*TrainingJob) Reset

func (m *TrainingJob) Reset()

func (*TrainingJob) String

func (m *TrainingJob) String() string

func (*TrainingJob) Validate

func (m *TrainingJob) Validate() error

Validate checks the field values on TrainingJob with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*TrainingJob) XXX_DiscardUnknown

func (m *TrainingJob) XXX_DiscardUnknown()

func (*TrainingJob) XXX_Marshal

func (m *TrainingJob) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TrainingJob) XXX_Merge

func (m *TrainingJob) XXX_Merge(src proto.Message)

func (*TrainingJob) XXX_Size

func (m *TrainingJob) XXX_Size() int

func (*TrainingJob) XXX_Unmarshal

func (m *TrainingJob) XXX_Unmarshal(b []byte) error

type TrainingJobEarlyStoppingType

type TrainingJobEarlyStoppingType struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

When the training jobs launched by the hyperparameter tuning job are not improving significantly, a hyperparameter tuning job can be stopping early. Note that there's only a subset of built-in algorithms that supports early stopping. see: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html

func (*TrainingJobEarlyStoppingType) Descriptor

func (*TrainingJobEarlyStoppingType) Descriptor() ([]byte, []int)

func (*TrainingJobEarlyStoppingType) ProtoMessage

func (*TrainingJobEarlyStoppingType) ProtoMessage()

func (*TrainingJobEarlyStoppingType) Reset

func (m *TrainingJobEarlyStoppingType) Reset()

func (*TrainingJobEarlyStoppingType) String

func (*TrainingJobEarlyStoppingType) Validate

func (m *TrainingJobEarlyStoppingType) Validate() error

Validate checks the field values on TrainingJobEarlyStoppingType with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*TrainingJobEarlyStoppingType) XXX_DiscardUnknown

func (m *TrainingJobEarlyStoppingType) XXX_DiscardUnknown()

func (*TrainingJobEarlyStoppingType) XXX_Marshal

func (m *TrainingJobEarlyStoppingType) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TrainingJobEarlyStoppingType) XXX_Merge

func (m *TrainingJobEarlyStoppingType) XXX_Merge(src proto.Message)

func (*TrainingJobEarlyStoppingType) XXX_Size

func (m *TrainingJobEarlyStoppingType) XXX_Size() int

func (*TrainingJobEarlyStoppingType) XXX_Unmarshal

func (m *TrainingJobEarlyStoppingType) XXX_Unmarshal(b []byte) error

type TrainingJobEarlyStoppingTypeValidationError

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

TrainingJobEarlyStoppingTypeValidationError is the validation error returned by TrainingJobEarlyStoppingType.Validate if the designated constraints aren't met.

func (TrainingJobEarlyStoppingTypeValidationError) Cause

Cause function returns cause value.

func (TrainingJobEarlyStoppingTypeValidationError) Error

Error satisfies the builtin error interface

func (TrainingJobEarlyStoppingTypeValidationError) ErrorName

ErrorName returns error name.

func (TrainingJobEarlyStoppingTypeValidationError) Field

Field function returns field value.

func (TrainingJobEarlyStoppingTypeValidationError) Key

Key function returns key value.

func (TrainingJobEarlyStoppingTypeValidationError) Reason

Reason function returns reason value.

type TrainingJobEarlyStoppingType_Value

type TrainingJobEarlyStoppingType_Value int32
const (
	TrainingJobEarlyStoppingType_OFF  TrainingJobEarlyStoppingType_Value = 0
	TrainingJobEarlyStoppingType_AUTO TrainingJobEarlyStoppingType_Value = 1
)

func (TrainingJobEarlyStoppingType_Value) EnumDescriptor

func (TrainingJobEarlyStoppingType_Value) EnumDescriptor() ([]byte, []int)

func (TrainingJobEarlyStoppingType_Value) String

type TrainingJobResourceConfig

type TrainingJobResourceConfig struct {
	// The number of ML compute instances to use. For distributed training, provide a value greater than 1.
	InstanceCount int64 `protobuf:"varint,1,opt,name=instance_count,json=instanceCount,proto3" json:"instance_count,omitempty"`
	// The ML compute instance type
	InstanceType string `protobuf:"bytes,2,opt,name=instance_type,json=instanceType,proto3" json:"instance_type,omitempty"`
	// The size of the ML storage volume that you want to provision.
	VolumeSizeInGb int64 `protobuf:"varint,3,opt,name=volume_size_in_gb,json=volumeSizeInGb,proto3" json:"volume_size_in_gb,omitempty"`
	// When users specify an instance_count > 1, Flyte will try to configure SageMaker to enable distributed training.
	// If the users wish to use framework-agnostic distributed protocol such as MPI or Parameter Server, this
	// field should be set to the corresponding enum value
	DistributedProtocol  DistributedProtocol_Value `` /* 177-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

TrainingJobResourceConfig is a pass-through, specifying the instance type to use for the training job, the number of instances to launch, and the size of the ML storage volume the user wants to provision Refer to SageMaker official doc for more details: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html

func (*TrainingJobResourceConfig) Descriptor

func (*TrainingJobResourceConfig) Descriptor() ([]byte, []int)

func (*TrainingJobResourceConfig) GetDistributedProtocol added in v0.18.9

func (m *TrainingJobResourceConfig) GetDistributedProtocol() DistributedProtocol_Value

func (*TrainingJobResourceConfig) GetInstanceCount

func (m *TrainingJobResourceConfig) GetInstanceCount() int64

func (*TrainingJobResourceConfig) GetInstanceType

func (m *TrainingJobResourceConfig) GetInstanceType() string

func (*TrainingJobResourceConfig) GetVolumeSizeInGb

func (m *TrainingJobResourceConfig) GetVolumeSizeInGb() int64

func (*TrainingJobResourceConfig) ProtoMessage

func (*TrainingJobResourceConfig) ProtoMessage()

func (*TrainingJobResourceConfig) Reset

func (m *TrainingJobResourceConfig) Reset()

func (*TrainingJobResourceConfig) String

func (m *TrainingJobResourceConfig) String() string

func (*TrainingJobResourceConfig) Validate

func (m *TrainingJobResourceConfig) Validate() error

Validate checks the field values on TrainingJobResourceConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*TrainingJobResourceConfig) XXX_DiscardUnknown

func (m *TrainingJobResourceConfig) XXX_DiscardUnknown()

func (*TrainingJobResourceConfig) XXX_Marshal

func (m *TrainingJobResourceConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TrainingJobResourceConfig) XXX_Merge

func (m *TrainingJobResourceConfig) XXX_Merge(src proto.Message)

func (*TrainingJobResourceConfig) XXX_Size

func (m *TrainingJobResourceConfig) XXX_Size() int

func (*TrainingJobResourceConfig) XXX_Unmarshal

func (m *TrainingJobResourceConfig) XXX_Unmarshal(b []byte) error

type TrainingJobResourceConfigValidationError

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

TrainingJobResourceConfigValidationError is the validation error returned by TrainingJobResourceConfig.Validate if the designated constraints aren't met.

func (TrainingJobResourceConfigValidationError) Cause

Cause function returns cause value.

func (TrainingJobResourceConfigValidationError) Error

Error satisfies the builtin error interface

func (TrainingJobResourceConfigValidationError) ErrorName

ErrorName returns error name.

func (TrainingJobResourceConfigValidationError) Field

Field function returns field value.

func (TrainingJobResourceConfigValidationError) Key

Key function returns key value.

func (TrainingJobResourceConfigValidationError) Reason

Reason function returns reason value.

type TrainingJobValidationError

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

TrainingJobValidationError is the validation error returned by TrainingJob.Validate if the designated constraints aren't met.

func (TrainingJobValidationError) Cause

Cause function returns cause value.

func (TrainingJobValidationError) Error

Error satisfies the builtin error interface

func (TrainingJobValidationError) ErrorName

func (e TrainingJobValidationError) ErrorName() string

ErrorName returns error name.

func (TrainingJobValidationError) Field

Field function returns field value.

func (TrainingJobValidationError) Key

Key function returns key value.

func (TrainingJobValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL