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: 7 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_EvaluationOptions_Task                 = proto.Task(1) // proto.Task_CLASSIFICATION
	Default_EvaluationOptions_PredictionSampling   = float32(1)
	Default_EvaluationOptions_BootstrappingSamples = int64(2000)
)

Default values for EvaluationOptions fields.

View Source
const (
	Default_EvaluationResults_CountPredictions         = float64(0)
	Default_EvaluationResults_CountPredictionsNoWeight = int64(0)
	Default_EvaluationResults_CountSampledPredictions  = float64(0)
	Default_EvaluationResults_Task                     = proto.Task(1) // proto.Task_CLASSIFICATION
)

Default values for EvaluationResults fields.

View Source
const (
	Default_EvaluationOptions_Classification_RocEnable     = bool(true)
	Default_EvaluationOptions_Classification_MaxRocSamples = int64(10000)
)

Default values for EvaluationOptions_Classification fields.

View Source
const (
	Default_EvaluationOptions_Ranking_NdcgTruncation    = int32(5)
	Default_EvaluationOptions_Ranking_MrrTruncation     = int32(10)
	Default_EvaluationOptions_Ranking_AllowOnlyOneGroup = bool(false)
)

Default values for EvaluationOptions_Ranking fields.

View Source
const (
	Default_EvaluationResults_Regression_SumSquareError = float64(0)
	Default_EvaluationResults_Regression_SumLabel       = float64(0)
	Default_EvaluationResults_Regression_SumSquareLabel = float64(0)
)

Default values for EvaluationResults_Regression fields.

View Source
const (
	Default_EvaluationResults_Ranking_NumGroups           = int64(0)
	Default_EvaluationResults_Ranking_MinNumItemsInGroup  = int64(0)
	Default_EvaluationResults_Ranking_MaxNumItemsInGroup  = int64(0)
	Default_EvaluationResults_Ranking_MeanNumItemsInGroup = float64(0)
	Default_EvaluationResults_Ranking_DefaultNdcg         = float64(0)
)

Default values for EvaluationResults_Ranking fields.

View Source
const (
	Default_EvaluationOptions_Regression_EnableRegressionPlots = bool(true)
)

Default values for EvaluationOptions_Regression fields.

View Source
const (
	Default_EvaluationResults_Classification_SumLogLoss = float64(0)
)

Default values for EvaluationResults_Classification fields.

Variables

View Source
var File_yggdrasil_decision_forests_metric_metric_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Bounds

type Bounds struct {
	Lower *float64 `protobuf:"fixed64,1,opt,name=lower" json:"lower,omitempty"`
	Upper *float64 `protobuf:"fixed64,2,opt,name=upper" json:"upper,omitempty"`
	// contains filtered or unexported fields
}

func (*Bounds) Descriptor deprecated

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

Deprecated: Use Bounds.ProtoReflect.Descriptor instead.

func (*Bounds) GetLower

func (x *Bounds) GetLower() float64

func (*Bounds) GetUpper

func (x *Bounds) GetUpper() float64

func (*Bounds) ProtoMessage

func (*Bounds) ProtoMessage()

func (*Bounds) ProtoReflect

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

func (*Bounds) Reset

func (x *Bounds) Reset()

func (*Bounds) String

func (x *Bounds) String() string

type EvaluationOptions

type EvaluationOptions struct {

	// Task of the model.
	Task *proto.Task `protobuf:"varint,1,opt,name=task,enum=yggdrasil_decision_forests.model.proto.Task,def=1" json:"task,omitempty"`
	// Evaluation configuration depending on the type of problem.
	//
	// Types that are assignable to TaskOptions:
	//	*EvaluationOptions_Classification_
	//	*EvaluationOptions_Regression_
	//	*EvaluationOptions_Ranking_
	//	*EvaluationOptions_Uplift_
	TaskOptions isEvaluationOptions_TaskOptions `protobuf_oneof:"task_options"`
	// Percentage of sampled predictions. If no predictions need to be sampled
	// (i.e. no part of the configuration needs it), this parameter is ignored and
	// no prediction is sampled.
	PredictionSampling *float32 `protobuf:"fixed32,4,opt,name=prediction_sampling,json=predictionSampling,def=1" json:"prediction_sampling,omitempty"`
	// Number of bootstrapping samples used to evaluate metric confidence
	// intervals and statistical test (i.e. all the metric ending with "[B]"). If
	// <=0, bootstrapping estimation is disabled. Note: Bootstrapping is done on
	// the sampled predictions (controlled by "prediction_sampling" parameter).
	// Note: Bootstrapping is an expensive computation. Therefore, for quick
	// experimentation with modeling, bootstrapping can be temporally reduced or
	// disabled.
	BootstrappingSamples *int64 `protobuf:"varint,5,opt,name=bootstrapping_samples,json=bootstrappingSamples,def=2000" json:"bootstrapping_samples,omitempty"`
	// Weights of the examples. This field does not have to match the
	// "weight_definition" in the model training. For example, the weighting can
	// be enabled for evaluation and disabled for training. Such case is rare
	// however.
	Weights *proto1.WeightDefinition `protobuf:"bytes,6,opt,name=weights" json:"weights,omitempty"`
	// contains filtered or unexported fields
}

Configuration of the evaluation of a model. Describes how the evaluation should be done.

func (*EvaluationOptions) Descriptor deprecated

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

Deprecated: Use EvaluationOptions.ProtoReflect.Descriptor instead.

func (*EvaluationOptions) GetBootstrappingSamples

func (x *EvaluationOptions) GetBootstrappingSamples() int64

func (*EvaluationOptions) GetClassification

func (x *EvaluationOptions) GetClassification() *EvaluationOptions_Classification

func (*EvaluationOptions) GetPredictionSampling

func (x *EvaluationOptions) GetPredictionSampling() float32

func (*EvaluationOptions) GetRanking

func (*EvaluationOptions) GetRegression

func (x *EvaluationOptions) GetRegression() *EvaluationOptions_Regression

func (*EvaluationOptions) GetTask

func (x *EvaluationOptions) GetTask() proto.Task

func (*EvaluationOptions) GetTaskOptions

func (m *EvaluationOptions) GetTaskOptions() isEvaluationOptions_TaskOptions

func (*EvaluationOptions) GetUplift

func (*EvaluationOptions) GetWeights

func (x *EvaluationOptions) GetWeights() *proto1.WeightDefinition

func (*EvaluationOptions) ProtoMessage

func (*EvaluationOptions) ProtoMessage()

func (*EvaluationOptions) ProtoReflect

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

func (*EvaluationOptions) Reset

func (x *EvaluationOptions) Reset()

func (*EvaluationOptions) String

func (x *EvaluationOptions) String() string

type EvaluationOptions_Classification

type EvaluationOptions_Classification struct {

	// Do compute the ROC metrics (or other metrics using the same type of
	// computation e.g. PR-AUC, P@R).
	RocEnable *bool `protobuf:"varint,1,opt,name=roc_enable,json=rocEnable,def=1" json:"roc_enable,omitempty"`
	// Maximum number of points in the ROC curve.
	MaxRocSamples *int64 `protobuf:"varint,2,opt,name=max_roc_samples,json=maxRocSamples,def=10000" json:"max_roc_samples,omitempty"`
	// List of recall values (between 0 and 1) for the evaluation of precision
	// at given recall.
	PrecisionAtRecall []float64 `protobuf:"fixed64,3,rep,name=precision_at_recall,json=precisionAtRecall" json:"precision_at_recall,omitempty"`
	// List of precision values (between 0 and 1) for the evaluation of recall
	// at given precision.
	RecallAtPrecision []float64 `protobuf:"fixed64,4,rep,name=recall_at_precision,json=recallAtPrecision" json:"recall_at_precision,omitempty"`
	// List of volume values (between 0 and 1) for the evaluation of precision
	// at given volume.
	PrecisionAtVolume []float64 `protobuf:"fixed64,5,rep,name=precision_at_volume,json=precisionAtVolume" json:"precision_at_volume,omitempty"`
	// List of false positive rates for the evaluation of recall at given false
	// positive rates.
	RecallAtFalsePositiveRate []float64 `` /* 137-byte string literal not displayed */
	// List of false recall for the evaluation of false positive rate at given
	// recall.
	FalsePositiveRateAtRecall []float64 `` // Next ID: 8
	/* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EvaluationOptions_Classification) Descriptor deprecated

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

Deprecated: Use EvaluationOptions_Classification.ProtoReflect.Descriptor instead.

func (*EvaluationOptions_Classification) GetFalsePositiveRateAtRecall

func (x *EvaluationOptions_Classification) GetFalsePositiveRateAtRecall() []float64

func (*EvaluationOptions_Classification) GetMaxRocSamples

func (x *EvaluationOptions_Classification) GetMaxRocSamples() int64

func (*EvaluationOptions_Classification) GetPrecisionAtRecall

func (x *EvaluationOptions_Classification) GetPrecisionAtRecall() []float64

func (*EvaluationOptions_Classification) GetPrecisionAtVolume

func (x *EvaluationOptions_Classification) GetPrecisionAtVolume() []float64

func (*EvaluationOptions_Classification) GetRecallAtFalsePositiveRate

func (x *EvaluationOptions_Classification) GetRecallAtFalsePositiveRate() []float64

func (*EvaluationOptions_Classification) GetRecallAtPrecision

func (x *EvaluationOptions_Classification) GetRecallAtPrecision() []float64

func (*EvaluationOptions_Classification) GetRocEnable

func (x *EvaluationOptions_Classification) GetRocEnable() bool

func (*EvaluationOptions_Classification) ProtoMessage

func (*EvaluationOptions_Classification) ProtoMessage()

func (*EvaluationOptions_Classification) ProtoReflect

func (*EvaluationOptions_Classification) Reset

func (*EvaluationOptions_Classification) String

type EvaluationOptions_Classification_

type EvaluationOptions_Classification_ struct {
	Classification *EvaluationOptions_Classification `protobuf:"bytes,2,opt,name=classification,oneof"`
}

type EvaluationOptions_Ranking

type EvaluationOptions_Ranking struct {

	// Number of evaluated elements.
	NdcgTruncation *int32 `protobuf:"varint,1,opt,name=ndcg_truncation,json=ndcgTruncation,def=5" json:"ndcg_truncation,omitempty"`
	// Rank cut-off at which Mean Reciprocal Rank is computed.
	MrrTruncation *int32 `protobuf:"varint,2,opt,name=mrr_truncation,json=mrrTruncation,def=10" json:"mrr_truncation,omitempty"`
	// If false (default) and if all the predictions (items) are in the same
	// group (i.e. there is only one group), raises an error.
	AllowOnlyOneGroup *bool `protobuf:"varint,3,opt,name=allow_only_one_group,json=allowOnlyOneGroup,def=0" json:"allow_only_one_group,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluationOptions_Ranking) Descriptor deprecated

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

Deprecated: Use EvaluationOptions_Ranking.ProtoReflect.Descriptor instead.

func (*EvaluationOptions_Ranking) GetAllowOnlyOneGroup

func (x *EvaluationOptions_Ranking) GetAllowOnlyOneGroup() bool

func (*EvaluationOptions_Ranking) GetMrrTruncation

func (x *EvaluationOptions_Ranking) GetMrrTruncation() int32

func (*EvaluationOptions_Ranking) GetNdcgTruncation

func (x *EvaluationOptions_Ranking) GetNdcgTruncation() int32

func (*EvaluationOptions_Ranking) ProtoMessage

func (*EvaluationOptions_Ranking) ProtoMessage()

func (*EvaluationOptions_Ranking) ProtoReflect

func (*EvaluationOptions_Ranking) Reset

func (x *EvaluationOptions_Ranking) Reset()

func (*EvaluationOptions_Ranking) String

func (x *EvaluationOptions_Ranking) String() string

type EvaluationOptions_Ranking_

type EvaluationOptions_Ranking_ struct {
	Ranking *EvaluationOptions_Ranking `protobuf:"bytes,7,opt,name=ranking,oneof"`
}

type EvaluationOptions_Regression

type EvaluationOptions_Regression struct {

	// Do compute the regression plots (histogram of ground truth, residual and
	// predictions, normality test of residual, conditional plots).
	EnableRegressionPlots *bool `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EvaluationOptions_Regression) Descriptor deprecated

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

Deprecated: Use EvaluationOptions_Regression.ProtoReflect.Descriptor instead.

func (*EvaluationOptions_Regression) GetEnableRegressionPlots

func (x *EvaluationOptions_Regression) GetEnableRegressionPlots() bool

func (*EvaluationOptions_Regression) ProtoMessage

func (*EvaluationOptions_Regression) ProtoMessage()

func (*EvaluationOptions_Regression) ProtoReflect

func (*EvaluationOptions_Regression) Reset

func (x *EvaluationOptions_Regression) Reset()

func (*EvaluationOptions_Regression) String

type EvaluationOptions_Regression_

type EvaluationOptions_Regression_ struct {
	Regression *EvaluationOptions_Regression `protobuf:"bytes,3,opt,name=regression,oneof"`
}

type EvaluationOptions_Uplift

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

func (*EvaluationOptions_Uplift) Descriptor deprecated

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

Deprecated: Use EvaluationOptions_Uplift.ProtoReflect.Descriptor instead.

func (*EvaluationOptions_Uplift) ProtoMessage

func (*EvaluationOptions_Uplift) ProtoMessage()

func (*EvaluationOptions_Uplift) ProtoReflect

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

func (*EvaluationOptions_Uplift) Reset

func (x *EvaluationOptions_Uplift) Reset()

func (*EvaluationOptions_Uplift) String

func (x *EvaluationOptions_Uplift) String() string

type EvaluationOptions_Uplift_

type EvaluationOptions_Uplift_ struct {
	Uplift *EvaluationOptions_Uplift `protobuf:"bytes,8,opt,name=uplift,oneof"`
}

type EvaluationResults

type EvaluationResults struct {

	// Number of predictions (weighted by example weight).
	CountPredictions *float64 `protobuf:"fixed64,1,opt,name=count_predictions,json=countPredictions,def=0" json:"count_predictions,omitempty"`
	// Number of predictions (without weights).
	CountPredictionsNoWeight *int64 `` /* 137-byte string literal not displayed */
	// Samples predictions. Only sampled if necessary (e.g. if ROC is computed).
	SampledPredictions []*proto.Prediction `protobuf:"bytes,3,rep,name=sampled_predictions,json=sampledPredictions" json:"sampled_predictions,omitempty"`
	// Number of sampled predictions (weighted by example weight).
	CountSampledPredictions *float64 `` /* 133-byte string literal not displayed */
	// Task of the model.
	Task *proto.Task `protobuf:"varint,5,opt,name=task,enum=yggdrasil_decision_forests.model.proto.Task,def=1" json:"task,omitempty"`
	// Evaluation results depending on the type of problem.
	//
	// Types that are assignable to Type:
	//	*EvaluationResults_Classification_
	//	*EvaluationResults_Regression_
	//	*EvaluationResults_Ranking_
	//	*EvaluationResults_Uplift_
	Type isEvaluationResults_Type `protobuf_oneof:"type"`
	// The dataspec of the label column. This field can contain information such
	// as: The possible label values, the distribution of the label values, the
	// string representation of the label value, etc.
	LabelColumn *proto1.Column `protobuf:"bytes,8,opt,name=label_column,json=labelColumn" json:"label_column,omitempty"`
	// Training time of the model. In case of cross-validation evaluation results,
	// "training_duration_in_seconds" is the average training time of a single
	// model.
	TrainingDurationInSeconds *float32 `` /* 135-byte string literal not displayed */
	// Value of the loss function used to optimize the model.
	//
	// Not all machine learning algorithms are optimizing a loss function, and
	// different loss functions can be compatible for a given task.
	LossValue *float32 `protobuf:"fixed32,10,opt,name=loss_value,json=lossValue" json:"loss_value,omitempty"`
	LossName  *string  `protobuf:"bytes,11,opt,name=loss_name,json=lossName" json:"loss_name,omitempty"`
	// Number of folds used for the evaluation.
	// The number of folds is 1 for train-and-test, and equals to the
	// cross-validation number of folds in case of cross-validation.
	NumFolds *int32 `protobuf:"varint,13,opt,name=num_folds,json=numFolds" json:"num_folds,omitempty"` // Next ID: 15
	// contains filtered or unexported fields
}

Evaluation results of a model.

This proto is generated by the "EvaluateLearner" or "model->Evaluate()" functions.

For manual evaluation, this proto is best generated using the "InitializeEvaluation", "AddPrediction" and "FinalizeEvaluation" functions in "metric.h".

This proto can be converted into human readable text with "AppendTextReport" or into a html+plot with "SaveEvaluationInDirectory". The html version contains more information that the raw text.

Individual metrics can be extracted using the utility methods defined in "metrics.h" e.g. "Accuracy()", "LogLoss()", "RMSE()".

func (*EvaluationResults) Descriptor deprecated

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

Deprecated: Use EvaluationResults.ProtoReflect.Descriptor instead.

func (*EvaluationResults) GetClassification

func (x *EvaluationResults) GetClassification() *EvaluationResults_Classification

func (*EvaluationResults) GetCountPredictions

func (x *EvaluationResults) GetCountPredictions() float64

func (*EvaluationResults) GetCountPredictionsNoWeight

func (x *EvaluationResults) GetCountPredictionsNoWeight() int64

func (*EvaluationResults) GetCountSampledPredictions

func (x *EvaluationResults) GetCountSampledPredictions() float64

func (*EvaluationResults) GetLabelColumn

func (x *EvaluationResults) GetLabelColumn() *proto1.Column

func (*EvaluationResults) GetLossName

func (x *EvaluationResults) GetLossName() string

func (*EvaluationResults) GetLossValue

func (x *EvaluationResults) GetLossValue() float32

func (*EvaluationResults) GetNumFolds

func (x *EvaluationResults) GetNumFolds() int32

func (*EvaluationResults) GetRanking

func (*EvaluationResults) GetRegression

func (x *EvaluationResults) GetRegression() *EvaluationResults_Regression

func (*EvaluationResults) GetSampledPredictions

func (x *EvaluationResults) GetSampledPredictions() []*proto.Prediction

func (*EvaluationResults) GetTask

func (x *EvaluationResults) GetTask() proto.Task

func (*EvaluationResults) GetTrainingDurationInSeconds

func (x *EvaluationResults) GetTrainingDurationInSeconds() float32

func (*EvaluationResults) GetType

func (m *EvaluationResults) GetType() isEvaluationResults_Type

func (*EvaluationResults) GetUplift

func (*EvaluationResults) ProtoMessage

func (*EvaluationResults) ProtoMessage()

func (*EvaluationResults) ProtoReflect

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

func (*EvaluationResults) Reset

func (x *EvaluationResults) Reset()

func (*EvaluationResults) String

func (x *EvaluationResults) String() string

type EvaluationResults_Classification

type EvaluationResults_Classification struct {

	// Confusion between the label and the predictions.
	Confusion *proto2.IntegersConfusionMatrixDouble `protobuf:"bytes,1,opt,name=confusion" json:"confusion,omitempty"`
	// One-vs-other Receiver operating characteristic curve. Indexed by the
	// categorical label value.
	Rocs []*Roc `protobuf:"bytes,2,rep,name=rocs" json:"rocs,omitempty"`
	// Sum of the log loss.
	SumLogLoss *float64 `protobuf:"fixed64,3,opt,name=sum_log_loss,json=sumLogLoss,def=0" json:"sum_log_loss,omitempty"`
	// Accuracy of the model. If both "accuracy" and "confusion" is specified,
	// they represent the same value.
	Accuracy *float64 `protobuf:"fixed64,5,opt,name=accuracy" json:"accuracy,omitempty"` // Next ID: 6
	// contains filtered or unexported fields
}

func (*EvaluationResults_Classification) Descriptor deprecated

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

Deprecated: Use EvaluationResults_Classification.ProtoReflect.Descriptor instead.

func (*EvaluationResults_Classification) GetAccuracy

func (x *EvaluationResults_Classification) GetAccuracy() float64

func (*EvaluationResults_Classification) GetConfusion

func (*EvaluationResults_Classification) GetRocs

func (x *EvaluationResults_Classification) GetRocs() []*Roc

func (*EvaluationResults_Classification) GetSumLogLoss

func (x *EvaluationResults_Classification) GetSumLogLoss() float64

func (*EvaluationResults_Classification) ProtoMessage

func (*EvaluationResults_Classification) ProtoMessage()

func (*EvaluationResults_Classification) ProtoReflect

func (*EvaluationResults_Classification) Reset

func (*EvaluationResults_Classification) String

type EvaluationResults_Classification_

type EvaluationResults_Classification_ struct {
	Classification *EvaluationResults_Classification `protobuf:"bytes,6,opt,name=classification,oneof"`
}

type EvaluationResults_Ranking

type EvaluationResults_Ranking struct {
	Ndcg                *MetricEstimate `protobuf:"bytes,5,opt,name=ndcg" json:"ndcg,omitempty"`
	NdcgTruncation      *int32          `protobuf:"varint,2,opt,name=ndcg_truncation,json=ndcgTruncation" json:"ndcg_truncation,omitempty"`
	NumGroups           *int64          `protobuf:"varint,3,opt,name=num_groups,json=numGroups,def=0" json:"num_groups,omitempty"`
	MinNumItemsInGroup  *int64          `protobuf:"varint,10,opt,name=min_num_items_in_group,json=minNumItemsInGroup,def=0" json:"min_num_items_in_group,omitempty"`
	MaxNumItemsInGroup  *int64          `protobuf:"varint,11,opt,name=max_num_items_in_group,json=maxNumItemsInGroup,def=0" json:"max_num_items_in_group,omitempty"`
	MeanNumItemsInGroup *float64        `` /* 126-byte string literal not displayed */
	DefaultNdcg         *float64        `protobuf:"fixed64,4,opt,name=default_ndcg,json=defaultNdcg,def=0" json:"default_ndcg,omitempty"`
	Mrr                 *MetricEstimate `protobuf:"bytes,8,opt,name=mrr" json:"mrr,omitempty"`
	MrrTruncation       *int32          `protobuf:"varint,9,opt,name=mrr_truncation,json=mrrTruncation" json:"mrr_truncation,omitempty"`
	// Fraction of examples were the highest predicted example is also the
	// example with the highest relevance value.
	PrecisionAt_1 *MetricEstimate `protobuf:"bytes,13,opt,name=precision_at_1,json=precisionAt1" json:"precision_at_1,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluationResults_Ranking) Descriptor deprecated

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

Deprecated: Use EvaluationResults_Ranking.ProtoReflect.Descriptor instead.

func (*EvaluationResults_Ranking) GetDefaultNdcg

func (x *EvaluationResults_Ranking) GetDefaultNdcg() float64

func (*EvaluationResults_Ranking) GetMaxNumItemsInGroup

func (x *EvaluationResults_Ranking) GetMaxNumItemsInGroup() int64

func (*EvaluationResults_Ranking) GetMeanNumItemsInGroup

func (x *EvaluationResults_Ranking) GetMeanNumItemsInGroup() float64

func (*EvaluationResults_Ranking) GetMinNumItemsInGroup

func (x *EvaluationResults_Ranking) GetMinNumItemsInGroup() int64

func (*EvaluationResults_Ranking) GetMrr

func (*EvaluationResults_Ranking) GetMrrTruncation

func (x *EvaluationResults_Ranking) GetMrrTruncation() int32

func (*EvaluationResults_Ranking) GetNdcg

func (*EvaluationResults_Ranking) GetNdcgTruncation

func (x *EvaluationResults_Ranking) GetNdcgTruncation() int32

func (*EvaluationResults_Ranking) GetNumGroups

func (x *EvaluationResults_Ranking) GetNumGroups() int64

func (*EvaluationResults_Ranking) GetPrecisionAt_1

func (x *EvaluationResults_Ranking) GetPrecisionAt_1() *MetricEstimate

func (*EvaluationResults_Ranking) ProtoMessage

func (*EvaluationResults_Ranking) ProtoMessage()

func (*EvaluationResults_Ranking) ProtoReflect

func (*EvaluationResults_Ranking) Reset

func (x *EvaluationResults_Ranking) Reset()

func (*EvaluationResults_Ranking) String

func (x *EvaluationResults_Ranking) String() string

type EvaluationResults_Ranking_

type EvaluationResults_Ranking_ struct {
	Ranking *EvaluationResults_Ranking `protobuf:"bytes,12,opt,name=ranking,oneof"`
}

type EvaluationResults_Regression

type EvaluationResults_Regression struct {

	// Sum for the squared error. For regression only.
	SumSquareError *float64 `protobuf:"fixed64,1,opt,name=sum_square_error,json=sumSquareError,def=0" json:"sum_square_error,omitempty"`
	// Sum of the labels.
	SumLabel *float64 `protobuf:"fixed64,2,opt,name=sum_label,json=sumLabel,def=0" json:"sum_label,omitempty"`
	// Sum of the square of the labels.
	SumSquareLabel *float64 `protobuf:"fixed64,3,opt,name=sum_square_label,json=sumSquareLabel,def=0" json:"sum_square_label,omitempty"`
	// Lower and upper bounds of the RMSE computed using non-parametric
	// bootstrapping.
	BootstrapRmseLowerBounds_95P *float64 `` /* 143-byte string literal not displayed */
	BootstrapRmseUpperBounds_95P *float64 `` // Next ID: 6
	/* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EvaluationResults_Regression) Descriptor deprecated

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

Deprecated: Use EvaluationResults_Regression.ProtoReflect.Descriptor instead.

func (*EvaluationResults_Regression) GetBootstrapRmseLowerBounds_95P

func (x *EvaluationResults_Regression) GetBootstrapRmseLowerBounds_95P() float64

func (*EvaluationResults_Regression) GetBootstrapRmseUpperBounds_95P

func (x *EvaluationResults_Regression) GetBootstrapRmseUpperBounds_95P() float64

func (*EvaluationResults_Regression) GetSumLabel

func (x *EvaluationResults_Regression) GetSumLabel() float64

func (*EvaluationResults_Regression) GetSumSquareError

func (x *EvaluationResults_Regression) GetSumSquareError() float64

func (*EvaluationResults_Regression) GetSumSquareLabel

func (x *EvaluationResults_Regression) GetSumSquareLabel() float64

func (*EvaluationResults_Regression) ProtoMessage

func (*EvaluationResults_Regression) ProtoMessage()

func (*EvaluationResults_Regression) ProtoReflect

func (*EvaluationResults_Regression) Reset

func (x *EvaluationResults_Regression) Reset()

func (*EvaluationResults_Regression) String

type EvaluationResults_Regression_

type EvaluationResults_Regression_ struct {
	Regression *EvaluationResults_Regression `protobuf:"bytes,7,opt,name=regression,oneof"`
}

type EvaluationResults_Uplift

type EvaluationResults_Uplift struct {

	// Note: In the case of multi-treatments, the "auuc" and "qini" are the
	// example weights average of the per-treatment AUUC and Qini.
	//
	// We use the implementation described in Guelman ("Optimal personalized
	// treatment learning models with insurance applications") or in Betlei
	// ("Treatment targeting by AUUC maximization with generalization
	// guarantees") work.
	Auuc *float64 `protobuf:"fixed64,1,opt,name=auuc" json:"auuc,omitempty"`
	Qini *float64 `protobuf:"fixed64,2,opt,name=qini" json:"qini,omitempty"`
	// Number of possible treatments. The treatment values (i.e. the value of
	// the categorical column specifying the treatment) are in [1,
	// num_treatments+1) with value "1" reserved for the control treatment.
	//
	// For example, in case of single-treatment vs control, "num_treatments=2"
	// and the treatment value will be 1 (control) or 2 (treatment).
	NumTreatments *int32 `protobuf:"varint,3,opt,name=num_treatments,json=numTreatments" json:"num_treatments,omitempty"`
	// The Conditional Average Treatment Effect Calibration metrics
	// (cate_calbration) computes the l2 expected calibration error of a binary
	// treatment uplift model. Miscalibration is a phenomenon that magnitute
	// of a treatment effect is overestimated due to overfitting CATE
	// training data. Here we use the expected "l2 norm of difference between
	// 1) predicted CATE, and 2) unbiased estimation of observed CATE" over all
	// uplift values.
	//
	// The metrics value is greater than 0, with lower values being more
	// desirable, i.e. "more calibrated". This metric is defined in
	// equation (2.4) of paper "Calibration Error for Heterogeneous Treatment
	// Effects", by Xu et al. (https://arxiv.org/pdf/2203.13364.pdf)
	CateCalibration *float64 `protobuf:"fixed64,4,opt,name=cate_calibration,json=cateCalibration" json:"cate_calibration,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluationResults_Uplift) Descriptor deprecated

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

Deprecated: Use EvaluationResults_Uplift.ProtoReflect.Descriptor instead.

func (*EvaluationResults_Uplift) GetAuuc

func (x *EvaluationResults_Uplift) GetAuuc() float64

func (*EvaluationResults_Uplift) GetCateCalibration

func (x *EvaluationResults_Uplift) GetCateCalibration() float64

func (*EvaluationResults_Uplift) GetNumTreatments

func (x *EvaluationResults_Uplift) GetNumTreatments() int32

func (*EvaluationResults_Uplift) GetQini

func (x *EvaluationResults_Uplift) GetQini() float64

func (*EvaluationResults_Uplift) ProtoMessage

func (*EvaluationResults_Uplift) ProtoMessage()

func (*EvaluationResults_Uplift) ProtoReflect

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

func (*EvaluationResults_Uplift) Reset

func (x *EvaluationResults_Uplift) Reset()

func (*EvaluationResults_Uplift) String

func (x *EvaluationResults_Uplift) String() string

type EvaluationResults_Uplift_

type EvaluationResults_Uplift_ struct {
	Uplift *EvaluationResults_Uplift `protobuf:"bytes,14,opt,name=uplift,oneof"`
}

type MetricAccessor

type MetricAccessor struct {

	// Types that are assignable to Task:
	//	*MetricAccessor_Classification_
	//	*MetricAccessor_Regression_
	//	*MetricAccessor_Loss_
	//	*MetricAccessor_Ranking_
	//	*MetricAccessor_Uplift_
	Task isMetricAccessor_Task `protobuf_oneof:"Task"`
	// contains filtered or unexported fields
}

Reference a metric."MetricAccessor" is used as a parameter of the function "GetMetric" to extract metric values from evaluation results proto.

Example: a = EvaluationResults { classification { accuracy:0.7 auc:0.8 ap:0.9 } } b = MetricAccessor { classification {}} GetMetric(a,b) -> 0.7

func (*MetricAccessor) Descriptor deprecated

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

Deprecated: Use MetricAccessor.ProtoReflect.Descriptor instead.

func (*MetricAccessor) GetClassification

func (x *MetricAccessor) GetClassification() *MetricAccessor_Classification

func (*MetricAccessor) GetLoss

func (x *MetricAccessor) GetLoss() *MetricAccessor_Loss

func (*MetricAccessor) GetRanking

func (x *MetricAccessor) GetRanking() *MetricAccessor_Ranking

func (*MetricAccessor) GetRegression

func (x *MetricAccessor) GetRegression() *MetricAccessor_Regression

func (*MetricAccessor) GetTask

func (m *MetricAccessor) GetTask() isMetricAccessor_Task

func (*MetricAccessor) GetUplift

func (x *MetricAccessor) GetUplift() *MetricAccessor_Uplift

func (*MetricAccessor) ProtoMessage

func (*MetricAccessor) ProtoMessage()

func (*MetricAccessor) ProtoReflect

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

func (*MetricAccessor) Reset

func (x *MetricAccessor) Reset()

func (*MetricAccessor) String

func (x *MetricAccessor) String() string

type MetricAccessor_Classification

type MetricAccessor_Classification struct {

	// Types that are assignable to Type:
	//	*MetricAccessor_Classification_Accuracy_
	//	*MetricAccessor_Classification_Logloss
	//	*MetricAccessor_Classification_OneVsOther_
	Type isMetricAccessor_Classification_Type `protobuf_oneof:"Type"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Classification.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification) GetAccuracy

func (*MetricAccessor_Classification) GetLogloss

func (*MetricAccessor_Classification) GetOneVsOther

func (*MetricAccessor_Classification) GetType

func (m *MetricAccessor_Classification) GetType() isMetricAccessor_Classification_Type

func (*MetricAccessor_Classification) ProtoMessage

func (*MetricAccessor_Classification) ProtoMessage()

func (*MetricAccessor_Classification) ProtoReflect

func (*MetricAccessor_Classification) Reset

func (x *MetricAccessor_Classification) Reset()

func (*MetricAccessor_Classification) String

type MetricAccessor_Classification_

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

type MetricAccessor_Classification_Accuracy

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

func (*MetricAccessor_Classification_Accuracy) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Classification_Accuracy.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_Accuracy) ProtoMessage

func (*MetricAccessor_Classification_Accuracy) ProtoReflect

func (*MetricAccessor_Classification_Accuracy) Reset

func (*MetricAccessor_Classification_Accuracy) String

type MetricAccessor_Classification_Accuracy_

type MetricAccessor_Classification_Accuracy_ struct {
	Accuracy *MetricAccessor_Classification_Accuracy `protobuf:"bytes,1,opt,name=accuracy,oneof"`
}

type MetricAccessor_Classification_LogLoss

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

func (*MetricAccessor_Classification_LogLoss) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Classification_LogLoss.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_LogLoss) ProtoMessage

func (*MetricAccessor_Classification_LogLoss) ProtoMessage()

func (*MetricAccessor_Classification_LogLoss) ProtoReflect

func (*MetricAccessor_Classification_LogLoss) Reset

func (*MetricAccessor_Classification_LogLoss) String

type MetricAccessor_Classification_Logloss

type MetricAccessor_Classification_Logloss struct {
	Logloss *MetricAccessor_Classification_LogLoss `protobuf:"bytes,2,opt,name=logloss,oneof"`
}

type MetricAccessor_Classification_OneVsOther

type MetricAccessor_Classification_OneVsOther struct {
	PositiveClass *string `protobuf:"bytes,1,opt,name=positive_class,json=positiveClass" json:"positive_class,omitempty"`
	// Types that are assignable to Type:
	//	*MetricAccessor_Classification_OneVsOther_Auc_
	//	*MetricAccessor_Classification_OneVsOther_PrAuc_
	//	*MetricAccessor_Classification_OneVsOther_Ap_
	//	*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall_
	//	*MetricAccessor_Classification_OneVsOther_RecallAtPrecision_
	//	*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume_
	//	*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate_
	//	*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall_
	Type isMetricAccessor_Classification_OneVsOther_Type `protobuf_oneof:"Type"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Classification_OneVsOther.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther) GetAp

func (*MetricAccessor_Classification_OneVsOther) GetAuc

func (*MetricAccessor_Classification_OneVsOther) GetFalsePositiveRateAtRecall

func (*MetricAccessor_Classification_OneVsOther) GetPositiveClass

func (x *MetricAccessor_Classification_OneVsOther) GetPositiveClass() string

func (*MetricAccessor_Classification_OneVsOther) GetPrAuc

func (*MetricAccessor_Classification_OneVsOther) GetPrecisionAtRecall

func (*MetricAccessor_Classification_OneVsOther) GetPrecisionAtVolume

func (*MetricAccessor_Classification_OneVsOther) GetRecallAtFalsePositiveRate

func (*MetricAccessor_Classification_OneVsOther) GetRecallAtPrecision

func (*MetricAccessor_Classification_OneVsOther) GetType

func (m *MetricAccessor_Classification_OneVsOther) GetType() isMetricAccessor_Classification_OneVsOther_Type

func (*MetricAccessor_Classification_OneVsOther) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther) Reset

func (*MetricAccessor_Classification_OneVsOther) String

type MetricAccessor_Classification_OneVsOther_

type MetricAccessor_Classification_OneVsOther_ struct {
	OneVsOther *MetricAccessor_Classification_OneVsOther `protobuf:"bytes,3,opt,name=one_vs_other,json=oneVsOther,oneof"`
}

type MetricAccessor_Classification_OneVsOther_Ap

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

func (*MetricAccessor_Classification_OneVsOther_Ap) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_Ap.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_Ap) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_Ap) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_Ap) Reset

func (*MetricAccessor_Classification_OneVsOther_Ap) String

type MetricAccessor_Classification_OneVsOther_Ap_

type MetricAccessor_Classification_OneVsOther_Ap_ struct {
	Ap *MetricAccessor_Classification_OneVsOther_Ap `protobuf:"bytes,4,opt,name=ap,oneof"`
}

type MetricAccessor_Classification_OneVsOther_Auc

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

func (*MetricAccessor_Classification_OneVsOther_Auc) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_Auc.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_Auc) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_Auc) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_Auc) Reset

func (*MetricAccessor_Classification_OneVsOther_Auc) String

type MetricAccessor_Classification_OneVsOther_Auc_

type MetricAccessor_Classification_OneVsOther_Auc_ struct {
	Auc *MetricAccessor_Classification_OneVsOther_Auc `protobuf:"bytes,2,opt,name=auc,oneof"`
}

type MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall

type MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall struct {
	Recall *float32 `protobuf:"fixed32,1,opt,name=recall" json:"recall,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) GetRecall

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) Reset

func (*MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall) String

type MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall_

type MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall_ struct {
	FalsePositiveRateAtRecall *MetricAccessor_Classification_OneVsOther_FalsePositiveRateAtRecall `protobuf:"bytes,9,opt,name=false_positive_rate_at_recall,json=falsePositiveRateAtRecall,oneof"`
}

type MetricAccessor_Classification_OneVsOther_PrAuc

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

func (*MetricAccessor_Classification_OneVsOther_PrAuc) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_PrAuc.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_PrAuc) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_PrAuc) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_PrAuc) Reset

func (*MetricAccessor_Classification_OneVsOther_PrAuc) String

type MetricAccessor_Classification_OneVsOther_PrAuc_

type MetricAccessor_Classification_OneVsOther_PrAuc_ struct {
	PrAuc *MetricAccessor_Classification_OneVsOther_PrAuc `protobuf:"bytes,3,opt,name=pr_auc,json=prAuc,oneof"`
}

type MetricAccessor_Classification_OneVsOther_PrecisionAtRecall

type MetricAccessor_Classification_OneVsOther_PrecisionAtRecall struct {
	Recall *float32 `protobuf:"fixed32,1,opt,name=recall" json:"recall,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_PrecisionAtRecall.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) GetRecall

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) Reset

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtRecall) String

type MetricAccessor_Classification_OneVsOther_PrecisionAtRecall_

type MetricAccessor_Classification_OneVsOther_PrecisionAtRecall_ struct {
	PrecisionAtRecall *MetricAccessor_Classification_OneVsOther_PrecisionAtRecall `protobuf:"bytes,5,opt,name=precision_at_recall,json=precisionAtRecall,oneof"`
}

type MetricAccessor_Classification_OneVsOther_PrecisionAtVolume

type MetricAccessor_Classification_OneVsOther_PrecisionAtVolume struct {
	Volume *float32 `protobuf:"fixed32,1,opt,name=volume" json:"volume,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_PrecisionAtVolume.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) GetVolume

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) Reset

func (*MetricAccessor_Classification_OneVsOther_PrecisionAtVolume) String

type MetricAccessor_Classification_OneVsOther_PrecisionAtVolume_

type MetricAccessor_Classification_OneVsOther_PrecisionAtVolume_ struct {
	PrecisionAtVolume *MetricAccessor_Classification_OneVsOther_PrecisionAtVolume `protobuf:"bytes,7,opt,name=precision_at_volume,json=precisionAtVolume,oneof"`
}

type MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate

type MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate struct {
	FalsePositiveRate *float32 `protobuf:"fixed32,1,opt,name=false_positive_rate,json=falsePositiveRate" json:"false_positive_rate,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) GetFalsePositiveRate

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) Reset

func (*MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate) String

type MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate_

type MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate_ struct {
	RecallAtFalsePositiveRate *MetricAccessor_Classification_OneVsOther_RecallAtFalsePositiveRate `protobuf:"bytes,8,opt,name=recall_at_false_positive_rate,json=recallAtFalsePositiveRate,oneof"`
}

type MetricAccessor_Classification_OneVsOther_RecallAtPrecision

type MetricAccessor_Classification_OneVsOther_RecallAtPrecision struct {
	Precision *float32 `protobuf:"fixed32,1,opt,name=precision" json:"precision,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) Descriptor deprecated

Deprecated: Use MetricAccessor_Classification_OneVsOther_RecallAtPrecision.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) GetPrecision

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) ProtoMessage

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) ProtoReflect

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) Reset

func (*MetricAccessor_Classification_OneVsOther_RecallAtPrecision) String

type MetricAccessor_Classification_OneVsOther_RecallAtPrecision_

type MetricAccessor_Classification_OneVsOther_RecallAtPrecision_ struct {
	RecallAtPrecision *MetricAccessor_Classification_OneVsOther_RecallAtPrecision `protobuf:"bytes,6,opt,name=recall_at_precision,json=recallAtPrecision,oneof"`
}

type MetricAccessor_Loss

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

func (*MetricAccessor_Loss) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Loss.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Loss) ProtoMessage

func (*MetricAccessor_Loss) ProtoMessage()

func (*MetricAccessor_Loss) ProtoReflect

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

func (*MetricAccessor_Loss) Reset

func (x *MetricAccessor_Loss) Reset()

func (*MetricAccessor_Loss) String

func (x *MetricAccessor_Loss) String() string

type MetricAccessor_Loss_

type MetricAccessor_Loss_ struct {
	Loss *MetricAccessor_Loss `protobuf:"bytes,3,opt,name=loss,oneof"`
}

type MetricAccessor_Ranking

type MetricAccessor_Ranking struct {

	// Types that are assignable to Type:
	//	*MetricAccessor_Ranking_Ndcg
	//	*MetricAccessor_Ranking_Mrr
	Type isMetricAccessor_Ranking_Type `protobuf_oneof:"Type"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Ranking) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Ranking.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Ranking) GetMrr

func (*MetricAccessor_Ranking) GetNdcg

func (*MetricAccessor_Ranking) GetType

func (m *MetricAccessor_Ranking) GetType() isMetricAccessor_Ranking_Type

func (*MetricAccessor_Ranking) ProtoMessage

func (*MetricAccessor_Ranking) ProtoMessage()

func (*MetricAccessor_Ranking) ProtoReflect

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

func (*MetricAccessor_Ranking) Reset

func (x *MetricAccessor_Ranking) Reset()

func (*MetricAccessor_Ranking) String

func (x *MetricAccessor_Ranking) String() string

type MetricAccessor_Ranking_

type MetricAccessor_Ranking_ struct {
	Ranking *MetricAccessor_Ranking `protobuf:"bytes,4,opt,name=ranking,oneof"`
}

type MetricAccessor_Ranking_MRR

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

func (*MetricAccessor_Ranking_MRR) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Ranking_MRR.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Ranking_MRR) ProtoMessage

func (*MetricAccessor_Ranking_MRR) ProtoMessage()

func (*MetricAccessor_Ranking_MRR) ProtoReflect

func (*MetricAccessor_Ranking_MRR) Reset

func (x *MetricAccessor_Ranking_MRR) Reset()

func (*MetricAccessor_Ranking_MRR) String

func (x *MetricAccessor_Ranking_MRR) String() string

type MetricAccessor_Ranking_Mrr

type MetricAccessor_Ranking_Mrr struct {
	Mrr *MetricAccessor_Ranking_MRR `protobuf:"bytes,2,opt,name=mrr,oneof"`
}

type MetricAccessor_Ranking_NDCG

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

func (*MetricAccessor_Ranking_NDCG) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Ranking_NDCG.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Ranking_NDCG) ProtoMessage

func (*MetricAccessor_Ranking_NDCG) ProtoMessage()

func (*MetricAccessor_Ranking_NDCG) ProtoReflect

func (*MetricAccessor_Ranking_NDCG) Reset

func (x *MetricAccessor_Ranking_NDCG) Reset()

func (*MetricAccessor_Ranking_NDCG) String

func (x *MetricAccessor_Ranking_NDCG) String() string

type MetricAccessor_Ranking_Ndcg

type MetricAccessor_Ranking_Ndcg struct {
	Ndcg *MetricAccessor_Ranking_NDCG `protobuf:"bytes,1,opt,name=ndcg,oneof"`
}

type MetricAccessor_Regression

type MetricAccessor_Regression struct {

	// Types that are assignable to Type:
	//	*MetricAccessor_Regression_Rmse_
	Type isMetricAccessor_Regression_Type `protobuf_oneof:"Type"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Regression) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Regression.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Regression) GetRmse

func (*MetricAccessor_Regression) GetType

func (m *MetricAccessor_Regression) GetType() isMetricAccessor_Regression_Type

func (*MetricAccessor_Regression) ProtoMessage

func (*MetricAccessor_Regression) ProtoMessage()

func (*MetricAccessor_Regression) ProtoReflect

func (*MetricAccessor_Regression) Reset

func (x *MetricAccessor_Regression) Reset()

func (*MetricAccessor_Regression) String

func (x *MetricAccessor_Regression) String() string

type MetricAccessor_Regression_

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

type MetricAccessor_Regression_Rmse

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

func (*MetricAccessor_Regression_Rmse) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Regression_Rmse.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Regression_Rmse) ProtoMessage

func (*MetricAccessor_Regression_Rmse) ProtoMessage()

func (*MetricAccessor_Regression_Rmse) ProtoReflect

func (*MetricAccessor_Regression_Rmse) Reset

func (x *MetricAccessor_Regression_Rmse) Reset()

func (*MetricAccessor_Regression_Rmse) String

type MetricAccessor_Regression_Rmse_

type MetricAccessor_Regression_Rmse_ struct {
	Rmse *MetricAccessor_Regression_Rmse `protobuf:"bytes,1,opt,name=rmse,oneof"`
}

type MetricAccessor_Uplift

type MetricAccessor_Uplift struct {

	// Types that are assignable to Type:
	//	*MetricAccessor_Uplift_Qini_
	//	*MetricAccessor_Uplift_CateCalibration_
	Type isMetricAccessor_Uplift_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*MetricAccessor_Uplift) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Uplift.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Uplift) GetCateCalibration

func (*MetricAccessor_Uplift) GetQini

func (*MetricAccessor_Uplift) GetType

func (m *MetricAccessor_Uplift) GetType() isMetricAccessor_Uplift_Type

func (*MetricAccessor_Uplift) ProtoMessage

func (*MetricAccessor_Uplift) ProtoMessage()

func (*MetricAccessor_Uplift) ProtoReflect

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

func (*MetricAccessor_Uplift) Reset

func (x *MetricAccessor_Uplift) Reset()

func (*MetricAccessor_Uplift) String

func (x *MetricAccessor_Uplift) String() string

type MetricAccessor_Uplift_

type MetricAccessor_Uplift_ struct {
	Uplift *MetricAccessor_Uplift `protobuf:"bytes,5,opt,name=uplift,oneof"`
}

type MetricAccessor_Uplift_CateCalibration

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

func (*MetricAccessor_Uplift_CateCalibration) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Uplift_CateCalibration.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Uplift_CateCalibration) ProtoMessage

func (*MetricAccessor_Uplift_CateCalibration) ProtoMessage()

func (*MetricAccessor_Uplift_CateCalibration) ProtoReflect

func (*MetricAccessor_Uplift_CateCalibration) Reset

func (*MetricAccessor_Uplift_CateCalibration) String

type MetricAccessor_Uplift_CateCalibration_

type MetricAccessor_Uplift_CateCalibration_ struct {
	CateCalibration *MetricAccessor_Uplift_CateCalibration `protobuf:"bytes,2,opt,name=cate_calibration,json=cateCalibration,oneof"`
}

type MetricAccessor_Uplift_Qini

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

func (*MetricAccessor_Uplift_Qini) Descriptor deprecated

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

Deprecated: Use MetricAccessor_Uplift_Qini.ProtoReflect.Descriptor instead.

func (*MetricAccessor_Uplift_Qini) ProtoMessage

func (*MetricAccessor_Uplift_Qini) ProtoMessage()

func (*MetricAccessor_Uplift_Qini) ProtoReflect

func (*MetricAccessor_Uplift_Qini) Reset

func (x *MetricAccessor_Uplift_Qini) Reset()

func (*MetricAccessor_Uplift_Qini) String

func (x *MetricAccessor_Uplift_Qini) String() string

type MetricAccessor_Uplift_Qini_

type MetricAccessor_Uplift_Qini_ struct {
	Qini *MetricAccessor_Uplift_Qini `protobuf:"bytes,1,opt,name=qini,oneof"`
}

type MetricEstimate

type MetricEstimate struct {

	// Expected value.
	Value *float64 `protobuf:"fixed64,1,opt,name=value" json:"value,omitempty"`
	// Upper and lower 95% bound estimated using bootstrapping.
	BootstrapBased_95P *Bounds `protobuf:"bytes,2,opt,name=bootstrap_based_95p,json=bootstrapBased95p" json:"bootstrap_based_95p,omitempty"`
	// contains filtered or unexported fields
}

Estimated measure of a metric.

func (*MetricEstimate) Descriptor deprecated

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

Deprecated: Use MetricEstimate.ProtoReflect.Descriptor instead.

func (*MetricEstimate) GetBootstrapBased_95P

func (x *MetricEstimate) GetBootstrapBased_95P() *Bounds

func (*MetricEstimate) GetValue

func (x *MetricEstimate) GetValue() float64

func (*MetricEstimate) ProtoMessage

func (*MetricEstimate) ProtoMessage()

func (*MetricEstimate) ProtoReflect

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

func (*MetricEstimate) Reset

func (x *MetricEstimate) Reset()

func (*MetricEstimate) String

func (x *MetricEstimate) String() string

type Roc

type Roc struct {

	// Points sorted with decreasing recall (i.e. increasing threshold).
	Curve []*Roc_Point `protobuf:"bytes,1,rep,name=curve" json:"curve,omitempty"`
	// Sum of the tp+fp+tn+fn of one element (this is the same for all elements).
	// "sum" is equal to "count_predictions" if the ROC is computed without
	// sampling (i.e. roc_prediction_sampling==1).
	CountPredictions *float64 `protobuf:"fixed64,2,opt,name=count_predictions,json=countPredictions" json:"count_predictions,omitempty"`
	// Area under the curve.
	Auc *float64 `protobuf:"fixed64,3,opt,name=auc" json:"auc,omitempty"`
	// Precision/Recall AUC.
	PrAuc *float64 `protobuf:"fixed64,4,opt,name=pr_auc,json=prAuc" json:"pr_auc,omitempty"`
	// Average Precision.
	Ap *float64 `protobuf:"fixed64,10,opt,name=ap" json:"ap,omitempty"`
	// Metric X evaluated under constraint of a given metric Y value.
	// These three fields have the same number of element as the fields of the
	// same name in "EvaluationOptions::Classification".
	PrecisionAtRecall         []*Roc_XAtYMetric `protobuf:"bytes,5,rep,name=precision_at_recall,json=precisionAtRecall" json:"precision_at_recall,omitempty"`
	RecallAtPrecision         []*Roc_XAtYMetric `protobuf:"bytes,6,rep,name=recall_at_precision,json=recallAtPrecision" json:"recall_at_precision,omitempty"`
	PrecisionAtVolume         []*Roc_XAtYMetric `protobuf:"bytes,7,rep,name=precision_at_volume,json=precisionAtVolume" json:"precision_at_volume,omitempty"`
	RecallAtFalsePositiveRate []*Roc_XAtYMetric `` /* 135-byte string literal not displayed */
	FalsePositiveRateAtRecall []*Roc_XAtYMetric `` /* 135-byte string literal not displayed */
	// Lower and upper bounds of all metrics computed using non-parametric
	// percentile bootstrapping. Only available if bootstrapping is enabled i.e.
	// num_bootstrapping_samples>=1.
	BootstrapLowerBounds_95P *Roc `` /* 128-byte string literal not displayed */
	BootstrapUpperBounds_95P *Roc `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

A receiver operating characteristic curve.

func (*Roc) Descriptor deprecated

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

Deprecated: Use Roc.ProtoReflect.Descriptor instead.

func (*Roc) GetAp

func (x *Roc) GetAp() float64

func (*Roc) GetAuc

func (x *Roc) GetAuc() float64

func (*Roc) GetBootstrapLowerBounds_95P

func (x *Roc) GetBootstrapLowerBounds_95P() *Roc

func (*Roc) GetBootstrapUpperBounds_95P

func (x *Roc) GetBootstrapUpperBounds_95P() *Roc

func (*Roc) GetCountPredictions

func (x *Roc) GetCountPredictions() float64

func (*Roc) GetCurve

func (x *Roc) GetCurve() []*Roc_Point

func (*Roc) GetFalsePositiveRateAtRecall

func (x *Roc) GetFalsePositiveRateAtRecall() []*Roc_XAtYMetric

func (*Roc) GetPrAuc

func (x *Roc) GetPrAuc() float64

func (*Roc) GetPrecisionAtRecall

func (x *Roc) GetPrecisionAtRecall() []*Roc_XAtYMetric

func (*Roc) GetPrecisionAtVolume

func (x *Roc) GetPrecisionAtVolume() []*Roc_XAtYMetric

func (*Roc) GetRecallAtFalsePositiveRate

func (x *Roc) GetRecallAtFalsePositiveRate() []*Roc_XAtYMetric

func (*Roc) GetRecallAtPrecision

func (x *Roc) GetRecallAtPrecision() []*Roc_XAtYMetric

func (*Roc) ProtoMessage

func (*Roc) ProtoMessage()

func (*Roc) ProtoReflect

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

func (*Roc) Reset

func (x *Roc) Reset()

func (*Roc) String

func (x *Roc) String() string

type Roc_Point

type Roc_Point struct {
	Threshold *float32 `protobuf:"fixed32,1,opt,name=threshold" json:"threshold,omitempty"`
	// True/False Positive/Negative.
	Tp *float64 `protobuf:"fixed64,2,opt,name=tp" json:"tp,omitempty"`
	Fp *float64 `protobuf:"fixed64,3,opt,name=fp" json:"fp,omitempty"`
	Tn *float64 `protobuf:"fixed64,4,opt,name=tn" json:"tn,omitempty"`
	Fn *float64 `protobuf:"fixed64,5,opt,name=fn" json:"fn,omitempty"`
	// contains filtered or unexported fields
}

func (*Roc_Point) Descriptor deprecated

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

Deprecated: Use Roc_Point.ProtoReflect.Descriptor instead.

func (*Roc_Point) GetFn

func (x *Roc_Point) GetFn() float64

func (*Roc_Point) GetFp

func (x *Roc_Point) GetFp() float64

func (*Roc_Point) GetThreshold

func (x *Roc_Point) GetThreshold() float32

func (*Roc_Point) GetTn

func (x *Roc_Point) GetTn() float64

func (*Roc_Point) GetTp

func (x *Roc_Point) GetTp() float64

func (*Roc_Point) ProtoMessage

func (*Roc_Point) ProtoMessage()

func (*Roc_Point) ProtoReflect

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

func (*Roc_Point) Reset

func (x *Roc_Point) Reset()

func (*Roc_Point) String

func (x *Roc_Point) String() string

type Roc_XAtYMetric

type Roc_XAtYMetric struct {
	YMetricConstraint *float64 `protobuf:"fixed64,1,opt,name=y_metric_constraint,json=yMetricConstraint" json:"y_metric_constraint,omitempty"`
	XMetricValue      *float64 `protobuf:"fixed64,2,opt,name=x_metric_value,json=xMetricValue" json:"x_metric_value,omitempty"`
	Threshold         *float32 `protobuf:"fixed32,3,opt,name=threshold" json:"threshold,omitempty"`
	// contains filtered or unexported fields
}

Value of a metric X (e.g. recall) for a given other metric Y value (e.g. FPR).

func (*Roc_XAtYMetric) Descriptor deprecated

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

Deprecated: Use Roc_XAtYMetric.ProtoReflect.Descriptor instead.

func (*Roc_XAtYMetric) GetThreshold

func (x *Roc_XAtYMetric) GetThreshold() float32

func (*Roc_XAtYMetric) GetXMetricValue

func (x *Roc_XAtYMetric) GetXMetricValue() float64

func (*Roc_XAtYMetric) GetYMetricConstraint

func (x *Roc_XAtYMetric) GetYMetricConstraint() float64

func (*Roc_XAtYMetric) ProtoMessage

func (*Roc_XAtYMetric) ProtoMessage()

func (*Roc_XAtYMetric) ProtoReflect

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

func (*Roc_XAtYMetric) Reset

func (x *Roc_XAtYMetric) Reset()

func (*Roc_XAtYMetric) String

func (x *Roc_XAtYMetric) String() string

Jump to

Keyboard shortcuts

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