proto

package
v0.0.0-...-7d47eef Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2023 License: Apache-2.0, MIT Imports: 6 Imported by: 0

Documentation

Overview

Package proto includes all proto definitions used in the golang package in one large package.

It uses go generate tools to generate it from the source code, but we include the generated files in github, so one doesn't need to install anything.

Index

Constants

View Source 
const (
	Default_AbstractModel_RankingGroupColIdx                 = int32(-1)
	Default_AbstractModel_ClassificationOutputsProbabilities = bool(true)
	Default_AbstractModel_UpliftTreatmentColIdx              = int32(-1)
	Default_AbstractModel_IsPureModel                        = bool(false)
)

Default values for AbstractModel fields.

View Source 
const (
	Default_Prediction_Weight = float32(1)
)

Default values for Prediction fields.

Variables

View Source 
var (
	Task_name = map[int32]string{
		0: "UNDEFINED",
		1: "CLASSIFICATION",
		2: "REGRESSION",
		3: "RANKING",
		4: "CATEGORICAL_UPLIFT",
		5: "NUMERICAL_UPLIFT",
	}
	Task_value = map[string]int32{
		"UNDEFINED":          0,
		"CLASSIFICATION":     1,
		"REGRESSION":         2,
		"RANKING":            3,
		"CATEGORICAL_UPLIFT": 4,
		"NUMERICAL_UPLIFT":   5,
	}
)

Enum value maps for Task.

View Source 
var File_yggdrasil_decision_forests_model_abstract_model_proto protoreflect.FileDescriptor
View Source 
var File_yggdrasil_decision_forests_model_hyperparameter_proto protoreflect.FileDescriptor
View Source 
var File_yggdrasil_decision_forests_model_prediction_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AbstractModel 

type AbstractModel struct {

	// Name of the model. Should match one of the registered models in the
	// :model_library.
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Task solved by the model e.g. classification, regression.
	Task *Task `protobuf:"varint,2,opt,name=task,enum=yggdrasil_decision_forests.model.proto.Task" json:"task,omitempty"`
	// Index of the label column in the dataspec.
	LabelColIdx *int32 `protobuf:"varint,3,opt,name=label_col_idx,json=labelColIdx" json:"label_col_idx,omitempty"`
	// Training example weights.
	Weights *proto.LinkedWeightDefinition `protobuf:"bytes,4,opt,name=weights" json:"weights,omitempty"`
	// List of indices (in the dataspec) of the model input features.
	InputFeatures []int32 `protobuf:"varint,5,rep,name=input_features,json=inputFeatures" json:"input_features,omitempty"`
	// Index of the "grouping" attribute in the dataspec for ranking problems e.g.
	// the query in a <query,document> ranking problem.
	RankingGroupColIdx *int32 `protobuf:"varint,6,opt,name=ranking_group_col_idx,json=rankingGroupColIdx,def=-1" json:"ranking_group_col_idx,omitempty"`
	// Pre-computed variable importances (VI). The VIs of the model are composed
	// of the pre-computed VIs (this field) and the "model specific VIs" (i.e.
	// variable importance computed on the fly based on the models structure).
	PrecomputedVariableImportances map[string]*VariableImportanceSet `` /* 220-byte string literal not displayed */
	// If true, the output of a task=CLASSIFICATION model is a probability and can
	// be used accordingly (e.g. averaged, clamped to [0,1]). If false, the output
	// of the task=CLASSIFICATION model might not be a probability.
	ClassificationOutputsProbabilities *bool `` /* 165-byte string literal not displayed */
	// Index of the "treatment" attribute in the dataspec for uplift problems.
	UpliftTreatmentColIdx *int32    `` /* 129-byte string literal not displayed */
	Metadata              *Metadata `protobuf:"bytes,10,opt,name=metadata" json:"metadata,omitempty"`
	// Logs of the automated hyper-parameter tuning of the model.
	HyperparameterOptimizerLogs *HyperparametersOptimizerLogs `` /* 138-byte string literal not displayed */
	// Indicate if a model is pure for serving i.e. the model was tripped of all
	// information not required for serving.
	IsPureModel *bool `protobuf:"varint,12,opt,name=is_pure_model,json=isPureModel,def=0" json:"is_pure_model,omitempty"`
	// contains filtered or unexported fields
}

Contains the same information as a model::AbstractModel (without the data_spec field).

func (*AbstractModel) Descriptor deprecated 

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

Deprecated: Use AbstractModel.ProtoReflect.Descriptor instead.

func (*AbstractModel) GetClassificationOutputsProbabilities 

func (x *AbstractModel) GetClassificationOutputsProbabilities() bool

func (*AbstractModel) GetHyperparameterOptimizerLogs 

func (x *AbstractModel) GetHyperparameterOptimizerLogs() *HyperparametersOptimizerLogs

func (*AbstractModel) GetInputFeatures 

func (x *AbstractModel) GetInputFeatures() []int32

func (*AbstractModel) GetIsPureModel 

func (x *AbstractModel) GetIsPureModel() bool

func (*AbstractModel) GetLabelColIdx 

func (x *AbstractModel) GetLabelColIdx() int32

func (*AbstractModel) GetMetadata 

func (x *AbstractModel) GetMetadata() *Metadata

func (*AbstractModel) GetName 

func (x *AbstractModel) GetName() string

func (*AbstractModel) GetPrecomputedVariableImportances 

func (x *AbstractModel) GetPrecomputedVariableImportances() map[string]*VariableImportanceSet

func (*AbstractModel) GetRankingGroupColIdx 

func (x *AbstractModel) GetRankingGroupColIdx() int32

func (*AbstractModel) GetTask 

func (x *AbstractModel) GetTask() Task

func (*AbstractModel) GetUpliftTreatmentColIdx 

func (x *AbstractModel) GetUpliftTreatmentColIdx() int32

func (*AbstractModel) GetWeights 

func (x *AbstractModel) GetWeights() *proto.LinkedWeightDefinition

func (*AbstractModel) ProtoMessage 

func (*AbstractModel) ProtoMessage()

func (*AbstractModel) ProtoReflect 

func (x *AbstractModel) ProtoReflect() protoreflect.Message

func (*AbstractModel) Reset 

func (x *AbstractModel) Reset()

func (*AbstractModel) String 

func (x *AbstractModel) String() string

type GenericHyperParameterSpecification 

type GenericHyperParameterSpecification struct {

	// Individual fields / hyper-parameters.
	// Also contains the per-fields documentation.
	Fields map[string]*GenericHyperParameterSpecification_Value `` /* 132-byte string literal not displayed */
	// Documentation for the entire learner.
	Documentation *GenericHyperParameterSpecification_LearnerDocumentation `protobuf:"bytes,2,opt,name=documentation" json:"documentation,omitempty"`
	// contains filtered or unexported fields
}

Definition of the type, possible values and default values of the generic hyper parameters of a learner. Also contains some documentation (free text + links).

func (*GenericHyperParameterSpecification) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification) GetDocumentation 

func (x *GenericHyperParameterSpecification) GetDocumentation() *GenericHyperParameterSpecification_LearnerDocumentation

func (*GenericHyperParameterSpecification) GetFields 

func (x *GenericHyperParameterSpecification) GetFields() map[string]*GenericHyperParameterSpecification_Value

func (*GenericHyperParameterSpecification) ProtoMessage 

func (*GenericHyperParameterSpecification) ProtoMessage()

func (*GenericHyperParameterSpecification) ProtoReflect 

func (x *GenericHyperParameterSpecification) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification) Reset 

func (x *GenericHyperParameterSpecification) Reset()

func (*GenericHyperParameterSpecification) String 

func (x *GenericHyperParameterSpecification) String() string

type GenericHyperParameterSpecification_Conditional 

type GenericHyperParameterSpecification_Conditional struct {

	// Name of the control parameter.
	ControlField *string `protobuf:"bytes,1,opt,name=control_field,json=controlField" json:"control_field,omitempty"`
	// Constraint on the parent.
	//
	// Types that are assignable to Constraint:
	//	*GenericHyperParameterSpecification_Conditional_Categorical_
	Constraint isGenericHyperParameterSpecification_Conditional_Constraint `protobuf_oneof:"constraint"`
	// contains filtered or unexported fields
}

Conditional existence of a parameter. A parameter exist iff. the other parameter "control_field" satisfy "constraint".

func (*GenericHyperParameterSpecification_Conditional) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Conditional.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Conditional) GetCategorical 

func (x *GenericHyperParameterSpecification_Conditional) GetCategorical() *GenericHyperParameterSpecification_Conditional_Categorical

func (*GenericHyperParameterSpecification_Conditional) GetConstraint 

func (m *GenericHyperParameterSpecification_Conditional) GetConstraint() isGenericHyperParameterSpecification_Conditional_Constraint

func (*GenericHyperParameterSpecification_Conditional) GetControlField 

func (x *GenericHyperParameterSpecification_Conditional) GetControlField() string

func (*GenericHyperParameterSpecification_Conditional) ProtoMessage 

func (*GenericHyperParameterSpecification_Conditional) ProtoMessage()

func (*GenericHyperParameterSpecification_Conditional) ProtoReflect 

func (x *GenericHyperParameterSpecification_Conditional) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Conditional) Reset 

func (x *GenericHyperParameterSpecification_Conditional) Reset()

func (*GenericHyperParameterSpecification_Conditional) String 

func (x *GenericHyperParameterSpecification_Conditional) String() string

type GenericHyperParameterSpecification_Conditional_Categorical 

type GenericHyperParameterSpecification_Conditional_Categorical struct {
	Values []string `protobuf:"bytes,1,rep,name=values" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericHyperParameterSpecification_Conditional_Categorical) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Conditional_Categorical.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Conditional_Categorical) GetValues 

func (x *GenericHyperParameterSpecification_Conditional_Categorical) GetValues() []string

func (*GenericHyperParameterSpecification_Conditional_Categorical) ProtoMessage 

func (*GenericHyperParameterSpecification_Conditional_Categorical) ProtoMessage()

func (*GenericHyperParameterSpecification_Conditional_Categorical) ProtoReflect 

func (x *GenericHyperParameterSpecification_Conditional_Categorical) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Conditional_Categorical) Reset 

func (x *GenericHyperParameterSpecification_Conditional_Categorical) Reset()

func (*GenericHyperParameterSpecification_Conditional_Categorical) String 

func (x *GenericHyperParameterSpecification_Conditional_Categorical) String() string

type GenericHyperParameterSpecification_Conditional_Categorical_ 

type GenericHyperParameterSpecification_Conditional_Categorical_ struct {
	// One of the following values.
	Categorical *GenericHyperParameterSpecification_Conditional_Categorical `protobuf:"bytes,2,opt,name=categorical,oneof"`
}

type GenericHyperParameterSpecification_LearnerDocumentation 

type GenericHyperParameterSpecification_LearnerDocumentation struct {

	// Free text description of the learning algorithm.
	Description *string `protobuf:"bytes,1,opt,name=description" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Documentation about the entire learner.

func (*GenericHyperParameterSpecification_LearnerDocumentation) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_LearnerDocumentation.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_LearnerDocumentation) GetDescription 

func (x *GenericHyperParameterSpecification_LearnerDocumentation) GetDescription() string

func (*GenericHyperParameterSpecification_LearnerDocumentation) ProtoMessage 

func (*GenericHyperParameterSpecification_LearnerDocumentation) ProtoMessage()

func (*GenericHyperParameterSpecification_LearnerDocumentation) ProtoReflect 

func (x *GenericHyperParameterSpecification_LearnerDocumentation) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_LearnerDocumentation) Reset 

func (x *GenericHyperParameterSpecification_LearnerDocumentation) Reset()

func (*GenericHyperParameterSpecification_LearnerDocumentation) String 

func (x *GenericHyperParameterSpecification_LearnerDocumentation) String() string

type GenericHyperParameterSpecification_Value 

type GenericHyperParameterSpecification_Value struct {

	// Types that are assignable to Type:
	//	*GenericHyperParameterSpecification_Value_Categorical_
	//	*GenericHyperParameterSpecification_Value_Integer_
	//	*GenericHyperParameterSpecification_Value_Real_
	//	*GenericHyperParameterSpecification_Value_CategoricalList_
	Type          isGenericHyperParameterSpecification_Value_Type         `protobuf_oneof:"Type"`
	Documentation *GenericHyperParameterSpecification_Value_Documentation `protobuf:"bytes,5,opt,name=documentation" json:"documentation,omitempty"`
	// If set, this parameter exist conditionally on other parameter values.
	Conditional *GenericHyperParameterSpecification_Conditional `protobuf:"bytes,7,opt,name=conditional" json:"conditional,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericHyperParameterSpecification_Value) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value) GetCategorical 

func (x *GenericHyperParameterSpecification_Value) GetCategorical() *GenericHyperParameterSpecification_Value_Categorical

func (*GenericHyperParameterSpecification_Value) GetCategoricalList 

func (x *GenericHyperParameterSpecification_Value) GetCategoricalList() *GenericHyperParameterSpecification_Value_CategoricalList

func (*GenericHyperParameterSpecification_Value) GetConditional 

func (x *GenericHyperParameterSpecification_Value) GetConditional() *GenericHyperParameterSpecification_Conditional

func (*GenericHyperParameterSpecification_Value) GetDocumentation 

func (x *GenericHyperParameterSpecification_Value) GetDocumentation() *GenericHyperParameterSpecification_Value_Documentation

func (*GenericHyperParameterSpecification_Value) GetInteger 

func (x *GenericHyperParameterSpecification_Value) GetInteger() *GenericHyperParameterSpecification_Value_Integer

func (*GenericHyperParameterSpecification_Value) GetReal 

func (x *GenericHyperParameterSpecification_Value) GetReal() *GenericHyperParameterSpecification_Value_Real

func (*GenericHyperParameterSpecification_Value) GetType 

func (m *GenericHyperParameterSpecification_Value) GetType() isGenericHyperParameterSpecification_Value_Type

func (*GenericHyperParameterSpecification_Value) ProtoMessage 

func (*GenericHyperParameterSpecification_Value) ProtoMessage()

func (*GenericHyperParameterSpecification_Value) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value) Reset 

func (x *GenericHyperParameterSpecification_Value) Reset()

func (*GenericHyperParameterSpecification_Value) String 

func (x *GenericHyperParameterSpecification_Value) String() string

type GenericHyperParameterSpecification_Value_Categorical 

type GenericHyperParameterSpecification_Value_Categorical struct {
	PossibleValues []string `protobuf:"bytes,1,rep,name=possible_values,json=possibleValues" json:"possible_values,omitempty"`
	DefaultValue   *string  `protobuf:"bytes,2,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Categorical hyper parameter i.e. the hyper parameter takes a values from a set of possible values.

func (*GenericHyperParameterSpecification_Value_Categorical) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value_Categorical.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value_Categorical) GetDefaultValue 

func (x *GenericHyperParameterSpecification_Value_Categorical) GetDefaultValue() string

func (*GenericHyperParameterSpecification_Value_Categorical) GetPossibleValues 

func (x *GenericHyperParameterSpecification_Value_Categorical) GetPossibleValues() []string

func (*GenericHyperParameterSpecification_Value_Categorical) ProtoMessage 

func (*GenericHyperParameterSpecification_Value_Categorical) ProtoMessage()

func (*GenericHyperParameterSpecification_Value_Categorical) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value_Categorical) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value_Categorical) Reset 

func (x *GenericHyperParameterSpecification_Value_Categorical) Reset()

func (*GenericHyperParameterSpecification_Value_Categorical) String 

func (x *GenericHyperParameterSpecification_Value_Categorical) String() string

type GenericHyperParameterSpecification_Value_CategoricalList 

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

List of categorical values.

func (*GenericHyperParameterSpecification_Value_CategoricalList) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value_CategoricalList.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value_CategoricalList) ProtoMessage 

func (*GenericHyperParameterSpecification_Value_CategoricalList) ProtoMessage()

func (*GenericHyperParameterSpecification_Value_CategoricalList) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value_CategoricalList) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value_CategoricalList) Reset 

func (x *GenericHyperParameterSpecification_Value_CategoricalList) Reset()

func (*GenericHyperParameterSpecification_Value_CategoricalList) String 

func (x *GenericHyperParameterSpecification_Value_CategoricalList) String() string

type GenericHyperParameterSpecification_Value_CategoricalList_ 

type GenericHyperParameterSpecification_Value_CategoricalList_ struct {
	CategoricalList *GenericHyperParameterSpecification_Value_CategoricalList `protobuf:"bytes,6,opt,name=categorical_list,json=categoricalList,oneof"`
}

type GenericHyperParameterSpecification_Value_Categorical_ 

type GenericHyperParameterSpecification_Value_Categorical_ struct {
	Categorical *GenericHyperParameterSpecification_Value_Categorical `protobuf:"bytes,2,opt,name=categorical,oneof"`
}

type GenericHyperParameterSpecification_Value_Documentation 

type GenericHyperParameterSpecification_Value_Documentation struct {

	// Path to the proto relative to simpleML root directory.
	ProtoPath *string `protobuf:"bytes,1,opt,name=proto_path,json=protoPath" json:"proto_path,omitempty"`
	// Name of the proto field. If not specific, use "name" instead.
	ProtoField *string `protobuf:"bytes,2,opt,name=proto_field,json=protoField" json:"proto_field,omitempty"`
	// Free text description of the parameter.
	Description *string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// When a field is deprecated.
	Deprecated *bool `protobuf:"varint,8,opt,name=deprecated" json:"deprecated,omitempty"`
	// contains filtered or unexported fields
}

Links to the documentation of the hyper-parameter.

func (*GenericHyperParameterSpecification_Value_Documentation) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value_Documentation.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value_Documentation) GetDeprecated 

func (x *GenericHyperParameterSpecification_Value_Documentation) GetDeprecated() bool

func (*GenericHyperParameterSpecification_Value_Documentation) GetDescription 

func (x *GenericHyperParameterSpecification_Value_Documentation) GetDescription() string

func (*GenericHyperParameterSpecification_Value_Documentation) GetProtoField 

func (x *GenericHyperParameterSpecification_Value_Documentation) GetProtoField() string

func (*GenericHyperParameterSpecification_Value_Documentation) GetProtoPath 

func (x *GenericHyperParameterSpecification_Value_Documentation) GetProtoPath() string

func (*GenericHyperParameterSpecification_Value_Documentation) ProtoMessage 

func (*GenericHyperParameterSpecification_Value_Documentation) ProtoMessage()

func (*GenericHyperParameterSpecification_Value_Documentation) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value_Documentation) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value_Documentation) Reset 

func (x *GenericHyperParameterSpecification_Value_Documentation) Reset()

func (*GenericHyperParameterSpecification_Value_Documentation) String 

func (x *GenericHyperParameterSpecification_Value_Documentation) String() string

type GenericHyperParameterSpecification_Value_Integer 

type GenericHyperParameterSpecification_Value_Integer struct {
	Minimum      *int32 `protobuf:"varint,1,opt,name=minimum" json:"minimum,omitempty"`
	Maximum      *int32 `protobuf:"varint,2,opt,name=maximum" json:"maximum,omitempty"`
	DefaultValue *int32 `protobuf:"varint,3,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Integer hyper parameter.

func (*GenericHyperParameterSpecification_Value_Integer) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value_Integer.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value_Integer) GetDefaultValue 

func (x *GenericHyperParameterSpecification_Value_Integer) GetDefaultValue() int32

func (*GenericHyperParameterSpecification_Value_Integer) GetMaximum 

func (x *GenericHyperParameterSpecification_Value_Integer) GetMaximum() int32

func (*GenericHyperParameterSpecification_Value_Integer) GetMinimum 

func (x *GenericHyperParameterSpecification_Value_Integer) GetMinimum() int32

func (*GenericHyperParameterSpecification_Value_Integer) ProtoMessage 

func (*GenericHyperParameterSpecification_Value_Integer) ProtoMessage()

func (*GenericHyperParameterSpecification_Value_Integer) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value_Integer) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value_Integer) Reset 

func (x *GenericHyperParameterSpecification_Value_Integer) Reset()

func (*GenericHyperParameterSpecification_Value_Integer) String 

func (x *GenericHyperParameterSpecification_Value_Integer) String() string

type GenericHyperParameterSpecification_Value_Integer_ 

type GenericHyperParameterSpecification_Value_Integer_ struct {
	Integer *GenericHyperParameterSpecification_Value_Integer `protobuf:"bytes,3,opt,name=integer,oneof"`
}

type GenericHyperParameterSpecification_Value_Real 

type GenericHyperParameterSpecification_Value_Real struct {
	Minimum      *float64 `protobuf:"fixed64,1,opt,name=minimum" json:"minimum,omitempty"`
	Maximum      *float64 `protobuf:"fixed64,2,opt,name=maximum" json:"maximum,omitempty"`
	DefaultValue *float64 `protobuf:"fixed64,3,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Real hyper parameter.

func (*GenericHyperParameterSpecification_Value_Real) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameterSpecification_Value_Real.ProtoReflect.Descriptor instead.

func (*GenericHyperParameterSpecification_Value_Real) GetDefaultValue 

func (x *GenericHyperParameterSpecification_Value_Real) GetDefaultValue() float64

func (*GenericHyperParameterSpecification_Value_Real) GetMaximum 

func (x *GenericHyperParameterSpecification_Value_Real) GetMaximum() float64

func (*GenericHyperParameterSpecification_Value_Real) GetMinimum 

func (x *GenericHyperParameterSpecification_Value_Real) GetMinimum() float64

func (*GenericHyperParameterSpecification_Value_Real) ProtoMessage 

func (*GenericHyperParameterSpecification_Value_Real) ProtoMessage()

func (*GenericHyperParameterSpecification_Value_Real) ProtoReflect 

func (x *GenericHyperParameterSpecification_Value_Real) ProtoReflect() protoreflect.Message

func (*GenericHyperParameterSpecification_Value_Real) Reset 

func (x *GenericHyperParameterSpecification_Value_Real) Reset()

func (*GenericHyperParameterSpecification_Value_Real) String 

func (x *GenericHyperParameterSpecification_Value_Real) String() string

type GenericHyperParameterSpecification_Value_Real_ 

type GenericHyperParameterSpecification_Value_Real_ struct {
	Real *GenericHyperParameterSpecification_Value_Real `protobuf:"bytes,4,opt,name=real,oneof"`
}

type GenericHyperParameters 

type GenericHyperParameters struct {
	Fields []*GenericHyperParameters_Field `protobuf:"bytes,1,rep,name=fields" json:"fields,omitempty"`
	// Unique id of the parameters.
	// Might be missing if the parameters are generated by a user, or by a
	// AbstractOptimizer that does not require ids.
	Id *int64 `protobuf:"varint,2,opt,name=id" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Generic hyper parameters of a learner.

Learner hyper parameters are normally provided through the "TrainingConfig" proto extended by each learner. The "Generic hyper parameters" (the following message) is a parallel solution to specify the hyper parameters of a learner using a list of key-values.

The "Generic hyper parameters" are designed for the interfacing with hyper-parameter optimization algorithms, while the "TrainingConfig" proto is designed for direct user input. For this reason, the generic hyper parameters are not guaranteed to be as expressive as the "TrainingConfig". However, the default values of the "Generic hyper parameters" are guaranteed to be equivalent to the default value of the training config.

func (*GenericHyperParameters) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameters.ProtoReflect.Descriptor instead.

func (*GenericHyperParameters) GetFields 

func (x *GenericHyperParameters) GetFields() []*GenericHyperParameters_Field

func (*GenericHyperParameters) GetId 

func (x *GenericHyperParameters) GetId() int64

func (*GenericHyperParameters) ProtoMessage 

func (*GenericHyperParameters) ProtoMessage()

func (*GenericHyperParameters) ProtoReflect 

func (x *GenericHyperParameters) ProtoReflect() protoreflect.Message

func (*GenericHyperParameters) Reset 

func (x *GenericHyperParameters) Reset()

func (*GenericHyperParameters) String 

func (x *GenericHyperParameters) String() string

type GenericHyperParameters_Field 

type GenericHyperParameters_Field struct {

	// Hyper parameter name. Should match the "name" of the hyper parameter
	// specification.
	Name  *string                       `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value *GenericHyperParameters_Value `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericHyperParameters_Field) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameters_Field.ProtoReflect.Descriptor instead.

func (*GenericHyperParameters_Field) GetName 

func (x *GenericHyperParameters_Field) GetName() string

func (*GenericHyperParameters_Field) GetValue 

func (x *GenericHyperParameters_Field) GetValue() *GenericHyperParameters_Value

func (*GenericHyperParameters_Field) ProtoMessage 

func (*GenericHyperParameters_Field) ProtoMessage()

func (*GenericHyperParameters_Field) ProtoReflect 

func (x *GenericHyperParameters_Field) ProtoReflect() protoreflect.Message

func (*GenericHyperParameters_Field) Reset 

func (x *GenericHyperParameters_Field) Reset()

func (*GenericHyperParameters_Field) String 

func (x *GenericHyperParameters_Field) String() string

type GenericHyperParameters_Value 

type GenericHyperParameters_Value struct {

	// Hyper parameter value. Should match the type defined in the hyper
	// parameter specification.
	//
	// Types that are assignable to Type:
	//	*GenericHyperParameters_Value_Categorical
	//	*GenericHyperParameters_Value_Integer
	//	*GenericHyperParameters_Value_Real
	//	*GenericHyperParameters_Value_CategoricalList_
	Type isGenericHyperParameters_Value_Type `protobuf_oneof:"Type"`
	// contains filtered or unexported fields
}

func (*GenericHyperParameters_Value) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameters_Value.ProtoReflect.Descriptor instead.

func (*GenericHyperParameters_Value) GetCategorical 

func (x *GenericHyperParameters_Value) GetCategorical() string

func (*GenericHyperParameters_Value) GetCategoricalList 

func (x *GenericHyperParameters_Value) GetCategoricalList() *GenericHyperParameters_Value_CategoricalList

func (*GenericHyperParameters_Value) GetInteger 

func (x *GenericHyperParameters_Value) GetInteger() int32

func (*GenericHyperParameters_Value) GetReal 

func (x *GenericHyperParameters_Value) GetReal() float64

func (*GenericHyperParameters_Value) GetType 

func (m *GenericHyperParameters_Value) GetType() isGenericHyperParameters_Value_Type

func (*GenericHyperParameters_Value) ProtoMessage 

func (*GenericHyperParameters_Value) ProtoMessage()

func (*GenericHyperParameters_Value) ProtoReflect 

func (x *GenericHyperParameters_Value) ProtoReflect() protoreflect.Message

func (*GenericHyperParameters_Value) Reset 

func (x *GenericHyperParameters_Value) Reset()

func (*GenericHyperParameters_Value) String 

func (x *GenericHyperParameters_Value) String() string

type GenericHyperParameters_Value_Categorical 

type GenericHyperParameters_Value_Categorical struct {
	Categorical string `protobuf:"bytes,2,opt,name=categorical,oneof"`
}

type GenericHyperParameters_Value_CategoricalList 

type GenericHyperParameters_Value_CategoricalList struct {
	Values []string `protobuf:"bytes,1,rep,name=values" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*GenericHyperParameters_Value_CategoricalList) Descriptor deprecated 

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

Deprecated: Use GenericHyperParameters_Value_CategoricalList.ProtoReflect.Descriptor instead.

func (*GenericHyperParameters_Value_CategoricalList) GetValues 

func (x *GenericHyperParameters_Value_CategoricalList) GetValues() []string

func (*GenericHyperParameters_Value_CategoricalList) ProtoMessage 

func (*GenericHyperParameters_Value_CategoricalList) ProtoMessage()

func (*GenericHyperParameters_Value_CategoricalList) ProtoReflect 

func (x *GenericHyperParameters_Value_CategoricalList) ProtoReflect() protoreflect.Message

func (*GenericHyperParameters_Value_CategoricalList) Reset 

func (x *GenericHyperParameters_Value_CategoricalList) Reset()

func (*GenericHyperParameters_Value_CategoricalList) String 

func (x *GenericHyperParameters_Value_CategoricalList) String() string

type GenericHyperParameters_Value_CategoricalList_ 

type GenericHyperParameters_Value_CategoricalList_ struct {
	CategoricalList *GenericHyperParameters_Value_CategoricalList `protobuf:"bytes,5,opt,name=categorical_list,json=categoricalList,oneof"`
}

type GenericHyperParameters_Value_Integer 

type GenericHyperParameters_Value_Integer struct {
	Integer int32 `protobuf:"varint,3,opt,name=integer,oneof"`
}

type GenericHyperParameters_Value_Real 

type GenericHyperParameters_Value_Real struct {
	Real float64 `protobuf:"fixed64,4,opt,name=real,oneof"`
}

type HyperParameterSpace 

type HyperParameterSpace struct {
	Fields []*HyperParameterSpace_Field `protobuf:"bytes,1,rep,name=fields" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

Set of hyper-parameter-sets aka. hyper-parameter search space.

func (*HyperParameterSpace) Descriptor deprecated 

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

Deprecated: Use HyperParameterSpace.ProtoReflect.Descriptor instead.

func (*HyperParameterSpace) GetFields 

func (x *HyperParameterSpace) GetFields() []*HyperParameterSpace_Field

func (*HyperParameterSpace) ProtoMessage 

func (*HyperParameterSpace) ProtoMessage()

func (*HyperParameterSpace) ProtoReflect 

func (x *HyperParameterSpace) ProtoReflect() protoreflect.Message

func (*HyperParameterSpace) Reset 

func (x *HyperParameterSpace) Reset()

func (*HyperParameterSpace) String 

func (x *HyperParameterSpace) String() string

type HyperParameterSpace_DiscreteCandidates 

type HyperParameterSpace_DiscreteCandidates struct {
	PossibleValues []*GenericHyperParameters_Value `protobuf:"bytes,1,rep,name=possible_values,json=possibleValues" json:"possible_values,omitempty"`
	// If set, "weights" has the same number of elements as "possible_values".
	// "weights[i]" is the weight of this specific value for the optimizer.
	// Different optimizers can use this weight differently.
	//
	// Random optimizer: Weight of the field during random sampling. If not
	//   specified, all the hyper-parameter combinations have the same
	//   probability of sampling. It means that a possible value with
	//   conditional children will be more likely to be sampled.
	Weights []float64 `protobuf:"fixed64,2,rep,name=weights" json:"weights,omitempty"`
	// contains filtered or unexported fields
}

func (*HyperParameterSpace_DiscreteCandidates) Descriptor deprecated 

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

Deprecated: Use HyperParameterSpace_DiscreteCandidates.ProtoReflect.Descriptor instead.

func (*HyperParameterSpace_DiscreteCandidates) GetPossibleValues 

func (x *HyperParameterSpace_DiscreteCandidates) GetPossibleValues() []*GenericHyperParameters_Value

func (*HyperParameterSpace_DiscreteCandidates) GetWeights 

func (x *HyperParameterSpace_DiscreteCandidates) GetWeights() []float64

func (*HyperParameterSpace_DiscreteCandidates) ProtoMessage 

func (*HyperParameterSpace_DiscreteCandidates) ProtoMessage()

func (*HyperParameterSpace_DiscreteCandidates) ProtoReflect 

func (x *HyperParameterSpace_DiscreteCandidates) ProtoReflect() protoreflect.Message

func (*HyperParameterSpace_DiscreteCandidates) Reset 

func (x *HyperParameterSpace_DiscreteCandidates) Reset()

func (*HyperParameterSpace_DiscreteCandidates) String 

func (x *HyperParameterSpace_DiscreteCandidates) String() string

type HyperParameterSpace_Field 

type HyperParameterSpace_Field struct {

	// Name of the hyper parameter. Should match one of the generic hyper
	// parameter of the model (use "GetGenericHyperParameterSpecification" for
	// the list of generic hyper parameters).
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Definition of the candidate values.
	//
	// Types that are assignable to Type:
	//	*HyperParameterSpace_Field_DiscreteCandidates
	Type isHyperParameterSpace_Field_Type `protobuf_oneof:"Type"`
	// If this field has a parent field, then it is only activated if its
	// parent's value is one of these.
	//
	// Types that are assignable to MatchingParentValues:
	//	*HyperParameterSpace_Field_ParentDiscreteValues
	MatchingParentValues isHyperParameterSpace_Field_MatchingParentValues `protobuf_oneof:"MatchingParentValues"`
	// List of child fields.
	Children []*HyperParameterSpace_Field `protobuf:"bytes,4,rep,name=children" json:"children,omitempty"`
	// contains filtered or unexported fields
}

func (*HyperParameterSpace_Field) Descriptor deprecated 

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

Deprecated: Use HyperParameterSpace_Field.ProtoReflect.Descriptor instead.

func (*HyperParameterSpace_Field) GetChildren 

func (x *HyperParameterSpace_Field) GetChildren() []*HyperParameterSpace_Field

func (*HyperParameterSpace_Field) GetDiscreteCandidates 

func (x *HyperParameterSpace_Field) GetDiscreteCandidates() *HyperParameterSpace_DiscreteCandidates

func (*HyperParameterSpace_Field) GetMatchingParentValues 

func (m *HyperParameterSpace_Field) GetMatchingParentValues() isHyperParameterSpace_Field_MatchingParentValues

func (*HyperParameterSpace_Field) GetName 

func (x *HyperParameterSpace_Field) GetName() string

func (*HyperParameterSpace_Field) GetParentDiscreteValues 

func (x *HyperParameterSpace_Field) GetParentDiscreteValues() *HyperParameterSpace_DiscreteCandidates

func (*HyperParameterSpace_Field) GetType 

func (m *HyperParameterSpace_Field) GetType() isHyperParameterSpace_Field_Type

func (*HyperParameterSpace_Field) ProtoMessage 

func (*HyperParameterSpace_Field) ProtoMessage()

func (*HyperParameterSpace_Field) ProtoReflect 

func (x *HyperParameterSpace_Field) ProtoReflect() protoreflect.Message

func (*HyperParameterSpace_Field) Reset 

func (x *HyperParameterSpace_Field) Reset()

func (*HyperParameterSpace_Field) String 

func (x *HyperParameterSpace_Field) String() string

type HyperParameterSpace_Field_DiscreteCandidates 

type HyperParameterSpace_Field_DiscreteCandidates struct {
	DiscreteCandidates *HyperParameterSpace_DiscreteCandidates `protobuf:"bytes,2,opt,name=discrete_candidates,json=discreteCandidates,oneof"`
}

type HyperParameterSpace_Field_ParentDiscreteValues 

type HyperParameterSpace_Field_ParentDiscreteValues struct {
	ParentDiscreteValues *HyperParameterSpace_DiscreteCandidates `protobuf:"bytes,3,opt,name=parent_discrete_values,json=parentDiscreteValues,oneof"`
}

type HyperparametersOptimizerLogs 

type HyperparametersOptimizerLogs struct {

	// Optimization steps ordered chronologically by evaluation_time.
	Steps []*HyperparametersOptimizerLogs_Step `protobuf:"bytes,1,rep,name=steps" json:"steps,omitempty"`
	// Domain of search for the hyper-parameters.
	Space *HyperParameterSpace `protobuf:"bytes,2,opt,name=space" json:"space,omitempty"`
	//  Registered key for the hyperparameter optimizer.
	HyperparameterOptimizerKey *string `` /* 134-byte string literal not displayed */
	// The selected hyperparameters and its score.
	//
	// Note: It is possible that the best hyperparameters are not part of the
	// "steps".
	BestHyperparameters *GenericHyperParameters `protobuf:"bytes,5,opt,name=best_hyperparameters,json=bestHyperparameters" json:"best_hyperparameters,omitempty"`
	BestScore           *float32                `protobuf:"fixed32,4,opt,name=best_score,json=bestScore" json:"best_score,omitempty"`
	// contains filtered or unexported fields
}

func (*HyperparametersOptimizerLogs) Descriptor deprecated 

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

Deprecated: Use HyperparametersOptimizerLogs.ProtoReflect.Descriptor instead.

func (*HyperparametersOptimizerLogs) GetBestHyperparameters 

func (x *HyperparametersOptimizerLogs) GetBestHyperparameters() *GenericHyperParameters

func (*HyperparametersOptimizerLogs) GetBestScore 

func (x *HyperparametersOptimizerLogs) GetBestScore() float32

func (*HyperparametersOptimizerLogs) GetHyperparameterOptimizerKey 

func (x *HyperparametersOptimizerLogs) GetHyperparameterOptimizerKey() string

func (*HyperparametersOptimizerLogs) GetSpace 

func (x *HyperparametersOptimizerLogs) GetSpace() *HyperParameterSpace

func (*HyperparametersOptimizerLogs) GetSteps 

func (x *HyperparametersOptimizerLogs) GetSteps() []*HyperparametersOptimizerLogs_Step

func (*HyperparametersOptimizerLogs) ProtoMessage 

func (*HyperparametersOptimizerLogs) ProtoMessage()

func (*HyperparametersOptimizerLogs) ProtoReflect 

func (x *HyperparametersOptimizerLogs) ProtoReflect() protoreflect.Message

func (*HyperparametersOptimizerLogs) Reset 

func (x *HyperparametersOptimizerLogs) Reset()

func (*HyperparametersOptimizerLogs) String 

func (x *HyperparametersOptimizerLogs) String() string

type HyperparametersOptimizerLogs_Step 

type HyperparametersOptimizerLogs_Step struct {

	// Time, in seconds, relative to the start of the hyper-parameter tuning, of
	// the consuption of the hyperparameters evaluation.
	EvaluationTime *float64 `protobuf:"fixed64,1,opt,name=evaluation_time,json=evaluationTime" json:"evaluation_time,omitempty"`
	// Tested hyperparameters.
	Hyperparameters *GenericHyperParameters `protobuf:"bytes,2,opt,name=hyperparameters" json:"hyperparameters,omitempty"`
	// Score (the higher, the better) of the hyperparameters.
	// A NaN value indicates that the hyperparameters are unfeasible.
	Score *float32 `protobuf:"fixed32,3,opt,name=score" json:"score,omitempty"`
	// contains filtered or unexported fields
}

func (*HyperparametersOptimizerLogs_Step) Descriptor deprecated 

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

Deprecated: Use HyperparametersOptimizerLogs_Step.ProtoReflect.Descriptor instead.

func (*HyperparametersOptimizerLogs_Step) GetEvaluationTime 

func (x *HyperparametersOptimizerLogs_Step) GetEvaluationTime() float64

func (*HyperparametersOptimizerLogs_Step) GetHyperparameters 

func (x *HyperparametersOptimizerLogs_Step) GetHyperparameters() *GenericHyperParameters

func (*HyperparametersOptimizerLogs_Step) GetScore 

func (x *HyperparametersOptimizerLogs_Step) GetScore() float32

func (*HyperparametersOptimizerLogs_Step) ProtoMessage 

func (*HyperparametersOptimizerLogs_Step) ProtoMessage()

func (*HyperparametersOptimizerLogs_Step) ProtoReflect 

func (x *HyperparametersOptimizerLogs_Step) ProtoReflect() protoreflect.Message

func (*HyperparametersOptimizerLogs_Step) Reset 

func (x *HyperparametersOptimizerLogs_Step) Reset()

func (*HyperparametersOptimizerLogs_Step) String 

func (x *HyperparametersOptimizerLogs_Step) String() string

type Metadata 

type Metadata struct {

	// Owner of the model. Default to the user who ran the training code if
	// available.
	Owner *string `protobuf:"bytes,1,opt,name=owner" json:"owner,omitempty"`
	// Unix Timestamp of the model training. Expressed in seconds.
	CreatedDate *int64 `protobuf:"varint,2,opt,name=created_date,json=createdDate" json:"created_date,omitempty"`
	// Unique identifier of the model.
	Uid *uint64 `protobuf:"varint,3,opt,name=uid" json:"uid,omitempty"`
	// Framework used to create the model.
	Framework *string `protobuf:"bytes,4,opt,name=framework" json:"framework,omitempty"`
	// contains filtered or unexported fields
}

Information about the model.

func (*Metadata) Descriptor deprecated 

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

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetCreatedDate 

func (x *Metadata) GetCreatedDate() int64

func (*Metadata) GetFramework 

func (x *Metadata) GetFramework() string

func (*Metadata) GetOwner 

func (x *Metadata) GetOwner() string

func (*Metadata) GetUid 

func (x *Metadata) GetUid() uint64

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect 

func (x *Metadata) ProtoReflect() protoreflect.Message

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type Prediction 

type Prediction struct {

	// Types that are assignable to Type:
	//	*Prediction_Classification_
	//	*Prediction_Regression_
	//	*Prediction_Ranking_
	//	*Prediction_Uplift_
	Type   isPrediction_Type `protobuf_oneof:"type"`
	Weight *float32          `protobuf:"fixed32,3,opt,name=weight,def=1" json:"weight,omitempty"`
	// Identifier about the example.
	ExampleKey *string `protobuf:"bytes,4,opt,name=example_key,json=exampleKey" json:"example_key,omitempty"`
	// contains filtered or unexported fields
}

Generic prediction (prediction over a single example). Those are usually the output of a ML model.

Optionally, it may contains the ground truth (e.g. the label value). When the ground truth is present, such a "Prediction" proto can be used for evaluation (see "metric.h").

func (*Prediction) Descriptor deprecated 

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

Deprecated: Use Prediction.ProtoReflect.Descriptor instead.

func (*Prediction) GetClassification 

func (x *Prediction) GetClassification() *Prediction_Classification

func (*Prediction) GetExampleKey 

func (x *Prediction) GetExampleKey() string

func (*Prediction) GetRanking 

func (x *Prediction) GetRanking() *Prediction_Ranking

func (*Prediction) GetRegression 

func (x *Prediction) GetRegression() *Prediction_Regression

func (*Prediction) GetType 

func (m *Prediction) GetType() isPrediction_Type

func (*Prediction) GetUplift 

func (x *Prediction) GetUplift() *Prediction_Uplift

func (*Prediction) GetWeight 

func (x *Prediction) GetWeight() float32

func (*Prediction) ProtoMessage 

func (*Prediction) ProtoMessage()

func (*Prediction) ProtoReflect 

func (x *Prediction) ProtoReflect() protoreflect.Message

func (*Prediction) Reset 

func (x *Prediction) Reset()

func (*Prediction) String 

func (x *Prediction) String() string

type Prediction_Classification 

type Prediction_Classification struct {

	// Predicted class as indexed in the dataspec.
	Value *int32 `protobuf:"varint,1,opt,name=value" json:"value,omitempty"`
	// Predicted distribution over the possible classes. If specified, the
	// following relation holds: "value == argmax_i(distribution[i])".
	Distribution *proto.IntegerDistributionFloat `protobuf:"bytes,2,opt,name=distribution" json:"distribution,omitempty"`
	GroundTruth  *int32                          `protobuf:"varint,3,opt,name=ground_truth,json=groundTruth" json:"ground_truth,omitempty"`
	// contains filtered or unexported fields
}

func (*Prediction_Classification) Descriptor deprecated 

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

Deprecated: Use Prediction_Classification.ProtoReflect.Descriptor instead.

func (*Prediction_Classification) GetDistribution 

func (x *Prediction_Classification) GetDistribution() *proto.IntegerDistributionFloat

func (*Prediction_Classification) GetGroundTruth 

func (x *Prediction_Classification) GetGroundTruth() int32

func (*Prediction_Classification) GetValue 

func (x *Prediction_Classification) GetValue() int32

func (*Prediction_Classification) ProtoMessage 

func (*Prediction_Classification) ProtoMessage()

func (*Prediction_Classification) ProtoReflect 

func (x *Prediction_Classification) ProtoReflect() protoreflect.Message

func (*Prediction_Classification) Reset 

func (x *Prediction_Classification) Reset()

func (*Prediction_Classification) String 

func (x *Prediction_Classification) String() string

type Prediction_Classification_ 

type Prediction_Classification_ struct {
	Classification *Prediction_Classification `protobuf:"bytes,1,opt,name=classification,oneof"`
}

type Prediction_Ranking 

type Prediction_Ranking struct {

	// Predicted relevance (the higher, the most likely to be selected).
	Relevance            *float32 `protobuf:"fixed32,1,opt,name=relevance" json:"relevance,omitempty"`
	GroundTruthRelevance *float32 `protobuf:"fixed32,2,opt,name=ground_truth_relevance,json=groundTruthRelevance" json:"ground_truth_relevance,omitempty"`
	// Group of the predictions. Predictions with a same group are competing.
	//
	// Deprecated: Do not use.
	DeprecatedGroup *int32 `protobuf:"varint,3,opt,name=deprecated_group,json=deprecatedGroup" json:"deprecated_group,omitempty"`
	// Group of the predictions. Can be a categorical or a hash value.
	GroupId *uint64 `protobuf:"varint,4,opt,name=group_id,json=groupId" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

func (*Prediction_Ranking) Descriptor deprecated 

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

Deprecated: Use Prediction_Ranking.ProtoReflect.Descriptor instead.

func (*Prediction_Ranking) GetDeprecatedGroup deprecated 

func (x *Prediction_Ranking) GetDeprecatedGroup() int32

Deprecated: Do not use.

func (*Prediction_Ranking) GetGroundTruthRelevance 

func (x *Prediction_Ranking) GetGroundTruthRelevance() float32

func (*Prediction_Ranking) GetGroupId 

func (x *Prediction_Ranking) GetGroupId() uint64

func (*Prediction_Ranking) GetRelevance 

func (x *Prediction_Ranking) GetRelevance() float32

func (*Prediction_Ranking) ProtoMessage 

func (*Prediction_Ranking) ProtoMessage()

func (*Prediction_Ranking) ProtoReflect 

func (x *Prediction_Ranking) ProtoReflect() protoreflect.Message

func (*Prediction_Ranking) Reset 

func (x *Prediction_Ranking) Reset()

func (*Prediction_Ranking) String 

func (x *Prediction_Ranking) String() string

type Prediction_Ranking_ 

type Prediction_Ranking_ struct {
	Ranking *Prediction_Ranking `protobuf:"bytes,5,opt,name=ranking,oneof"`
}

type Prediction_Regression 

type Prediction_Regression struct {
	Value       *float32 `protobuf:"fixed32,1,opt,name=value" json:"value,omitempty"`
	GroundTruth *float32 `protobuf:"fixed32,2,opt,name=ground_truth,json=groundTruth" json:"ground_truth,omitempty"`
	// contains filtered or unexported fields
}

func (*Prediction_Regression) Descriptor deprecated 

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

Deprecated: Use Prediction_Regression.ProtoReflect.Descriptor instead.

func (*Prediction_Regression) GetGroundTruth 

func (x *Prediction_Regression) GetGroundTruth() float32

func (*Prediction_Regression) GetValue 

func (x *Prediction_Regression) GetValue() float32

func (*Prediction_Regression) ProtoMessage 

func (*Prediction_Regression) ProtoMessage()

func (*Prediction_Regression) ProtoReflect 

func (x *Prediction_Regression) ProtoReflect() protoreflect.Message

func (*Prediction_Regression) Reset 

func (x *Prediction_Regression) Reset()

func (*Prediction_Regression) String 

func (x *Prediction_Regression) String() string

type Prediction_Regression_ 

type Prediction_Regression_ struct {
	Regression *Prediction_Regression `protobuf:"bytes,2,opt,name=regression,oneof"`
}

type Prediction_Uplift 

type Prediction_Uplift struct {

	// Predicted treatment effect.
	//
	// treatment_effect[i] is the effect of the "i+1"-th treatment (categorical
	// value i+2) compared to the control group (0-th treatment; categorical
	// value = 1). The treatment out-of-vocabulary item (value = 0) is not taken
	// into account.
	TreatmentEffect []float32 `protobuf:"fixed32,1,rep,packed,name=treatment_effect,json=treatmentEffect" json:"treatment_effect,omitempty"`
	// Applied treatment. The control group is treatment = 1. Other treatments
	// are >1.
	Treatment *int32 `protobuf:"varint,2,opt,name=treatment" json:"treatment,omitempty"`
	// Outcome (with or without treatment).
	//
	// Types that are assignable to OutcomeType:
	//	*Prediction_Uplift_OutcomeCategorical
	//	*Prediction_Uplift_OutcomeNumerical
	OutcomeType isPrediction_Uplift_OutcomeType `protobuf_oneof:"outcome_type"`
	// contains filtered or unexported fields
}

func (*Prediction_Uplift) Descriptor deprecated 

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

Deprecated: Use Prediction_Uplift.ProtoReflect.Descriptor instead.

func (*Prediction_Uplift) GetOutcomeCategorical 

func (x *Prediction_Uplift) GetOutcomeCategorical() int32

func (*Prediction_Uplift) GetOutcomeNumerical 

func (x *Prediction_Uplift) GetOutcomeNumerical() float32

func (*Prediction_Uplift) GetOutcomeType 

func (m *Prediction_Uplift) GetOutcomeType() isPrediction_Uplift_OutcomeType

func (*Prediction_Uplift) GetTreatment 

func (x *Prediction_Uplift) GetTreatment() int32

func (*Prediction_Uplift) GetTreatmentEffect 

func (x *Prediction_Uplift) GetTreatmentEffect() []float32

func (*Prediction_Uplift) ProtoMessage 

func (*Prediction_Uplift) ProtoMessage()

func (*Prediction_Uplift) ProtoReflect 

func (x *Prediction_Uplift) ProtoReflect() protoreflect.Message

func (*Prediction_Uplift) Reset 

func (x *Prediction_Uplift) Reset()

func (*Prediction_Uplift) String 

func (x *Prediction_Uplift) String() string

type Prediction_Uplift_ 

type Prediction_Uplift_ struct {
	Uplift *Prediction_Uplift `protobuf:"bytes,6,opt,name=uplift,oneof"`
}

type Prediction_Uplift_OutcomeCategorical 

type Prediction_Uplift_OutcomeCategorical struct {
	OutcomeCategorical int32 `protobuf:"varint,3,opt,name=outcome_categorical,json=outcomeCategorical,oneof"`
}

type Prediction_Uplift_OutcomeNumerical 

type Prediction_Uplift_OutcomeNumerical struct {
	OutcomeNumerical float32 `protobuf:"fixed32,4,opt,name=outcome_numerical,json=outcomeNumerical,oneof"`
}

type Task 

type Task int32

Modeling task. 

const (
	Task_UNDEFINED      Task = 0
	Task_CLASSIFICATION Task = 1
	Task_REGRESSION     Task = 2
	// In case of ranking, the label is expected to be between 0 and 4, and to
	// have the NDCG semantic:
	// 0: Completely unrelated.
	// 4: Perfect match.
	Task_RANKING Task = 3
	// Predicts the incremental impact of a treatment on a categorical outcome.
	// See https://en.wikipedia.org/wiki/Uplift_modelling.
	Task_CATEGORICAL_UPLIFT Task = 4
	// Predicts the incremental impact of a treatment on a numerical outcome.
	// See https://en.wikipedia.org/wiki/Uplift_modelling.
	Task_NUMERICAL_UPLIFT Task = 5
)

func (Task) Descriptor 

func (Task) Descriptor() protoreflect.EnumDescriptor

func (Task) Enum 

func (x Task) Enum() *Task

func (Task) EnumDescriptor deprecated 

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

Deprecated: Use Task.Descriptor instead.

func (Task) Number 

func (x Task) Number() protoreflect.EnumNumber

func (Task) String 

func (x Task) String() string

func (Task) Type 

func (Task) Type() protoreflect.EnumType

func (*Task) UnmarshalJSON deprecated 

func (x *Task) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type VariableImportance 

type VariableImportance struct {
	AttributeIdx *int32   `protobuf:"varint,1,opt,name=attribute_idx,json=attributeIdx" json:"attribute_idx,omitempty"`
	Importance   *float64 `protobuf:"fixed64,2,opt,name=importance" json:"importance,omitempty"`
	// contains filtered or unexported fields
}

Description of the importance of a given attribute. The semantic of "importance" is variable.

func (*VariableImportance) Descriptor deprecated 

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

Deprecated: Use VariableImportance.ProtoReflect.Descriptor instead.

func (*VariableImportance) GetAttributeIdx 

func (x *VariableImportance) GetAttributeIdx() int32

func (*VariableImportance) GetImportance 

func (x *VariableImportance) GetImportance() float64

func (*VariableImportance) ProtoMessage 

func (*VariableImportance) ProtoMessage()

func (*VariableImportance) ProtoReflect 

func (x *VariableImportance) ProtoReflect() protoreflect.Message

func (*VariableImportance) Reset 

func (x *VariableImportance) Reset()

func (*VariableImportance) String 

func (x *VariableImportance) String() string

type VariableImportanceSet 

type VariableImportanceSet struct {
	VariableImportances []*VariableImportance `protobuf:"bytes,1,rep,name=variable_importances,json=variableImportances" json:"variable_importances,omitempty"`
	// contains filtered or unexported fields
}

func (*VariableImportanceSet) Descriptor deprecated 

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

Deprecated: Use VariableImportanceSet.ProtoReflect.Descriptor instead.

func (*VariableImportanceSet) GetVariableImportances 

func (x *VariableImportanceSet) GetVariableImportances() []*VariableImportance

func (*VariableImportanceSet) ProtoMessage 

func (*VariableImportanceSet) ProtoMessage()

func (*VariableImportanceSet) ProtoReflect 

func (x *VariableImportanceSet) ProtoReflect() protoreflect.Message

func (*VariableImportanceSet) Reset 

func (x *VariableImportanceSet) Reset()

func (*VariableImportanceSet) String 

func (x *VariableImportanceSet) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.