proto

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
• Variables
• type Header
  • func (*Header) Descriptor() ([]byte, []int)
  • func (x *Header) GetMeanDecreaseInAccuracy() []*proto.VariableImportance
  • func (x *Header) GetMeanIncreaseInRmse() []*proto.VariableImportance
  • func (x *Header) GetNodeFormat() string
  • func (x *Header) GetNumNodeShards() int32
  • func (x *Header) GetNumPrunedNodes() int64
  • func (x *Header) GetNumTrees() int64
  • func (x *Header) GetOutOfBagEvaluations() []*OutOfBagTrainingEvaluations
  • func (x *Header) GetWinnerTakeAllInference() bool
  • func (*Header) ProtoMessage()
  • func (x *Header) ProtoReflect() protoreflect.Message
  • func (x *Header) Reset()
  • func (x *Header) String() string
• type OutOfBagTrainingEvaluations
  • func (*OutOfBagTrainingEvaluations) Descriptor() ([]byte, []int)
  • func (x *OutOfBagTrainingEvaluations) GetEvaluation() *proto1.EvaluationResults
  • func (x *OutOfBagTrainingEvaluations) GetNumberOfTrees() int32
  • func (*OutOfBagTrainingEvaluations) ProtoMessage()
  • func (x *OutOfBagTrainingEvaluations) ProtoReflect() protoreflect.Message
  • func (x *OutOfBagTrainingEvaluations) Reset()
  • func (x *OutOfBagTrainingEvaluations) String() string

Constants

const (
	Default_Header_WinnerTakeAllInference = bool(true)
	Default_Header_NodeFormat             = string("TFE_RECORDIO")
)

Default values for Header fields.

Variables

var File_yggdrasil_decision_forests_model_random_forest_random_forest_proto protoreflect.FileDescriptor

Types

type Header

type Header struct {

	// Number of shards used to store the nodes.
	NumNodeShards *int32 `protobuf:"varint,1,opt,name=num_node_shards,json=numNodeShards" json:"num_node_shards,omitempty"`
	// Number of trees.
	NumTrees *int64 `protobuf:"varint,2,opt,name=num_trees,json=numTrees" json:"num_trees,omitempty"`
	// Whether the vote of individual trees are distributions or winner-take-all.
	WinnerTakeAllInference *bool `` /* 131-byte string literal not displayed */
	// Evaluation of the model, on the out-of-bag examples, during the training.
	OutOfBagEvaluations []*OutOfBagTrainingEvaluations `protobuf:"bytes,4,rep,name=out_of_bag_evaluations,json=outOfBagEvaluations" json:"out_of_bag_evaluations,omitempty"`
	// Variable importance measures.
	MeanDecreaseInAccuracy []*proto.VariableImportance `protobuf:"bytes,5,rep,name=mean_decrease_in_accuracy,json=meanDecreaseInAccuracy" json:"mean_decrease_in_accuracy,omitempty"`
	MeanIncreaseInRmse     []*proto.VariableImportance `protobuf:"bytes,6,rep,name=mean_increase_in_rmse,json=meanIncreaseInRmse" json:"mean_increase_in_rmse,omitempty"`
	// Container used to store the trees' nodes.
	NodeFormat *string `protobuf:"bytes,7,opt,name=node_format,json=nodeFormat,def=TFE_RECORDIO" json:"node_format,omitempty"`
	// Number of nodes trained and then pruned during the training.
	// The classical random forest learning algorithm does not prune nodes.
	NumPrunedNodes *int64 `protobuf:"varint,8,opt,name=num_pruned_nodes,json=numPrunedNodes" json:"num_pruned_nodes,omitempty"`
	// contains filtered or unexported fields
}

Header for the random forest model.

func (*Header) Descriptor

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

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetMeanDecreaseInAccuracy

func (x *Header) GetMeanDecreaseInAccuracy() []*proto.VariableImportance

func (*Header) GetMeanIncreaseInRmse

func (x *Header) GetMeanIncreaseInRmse() []*proto.VariableImportance

func (*Header) GetNodeFormat

func (x *Header) GetNodeFormat() string

func (*Header) GetNumNodeShards

func (x *Header) GetNumNodeShards() int32

func (*Header) GetNumPrunedNodes

func (x *Header) GetNumPrunedNodes() int64

func (*Header) GetNumTrees

func (x *Header) GetNumTrees() int64

func (*Header) GetOutOfBagEvaluations

func (x *Header) GetOutOfBagEvaluations() []*OutOfBagTrainingEvaluations

func (*Header) GetWinnerTakeAllInference

func (x *Header) GetWinnerTakeAllInference() bool

func (*Header) ProtoMessage

func (*Header) ProtoMessage()

func (*Header) ProtoReflect

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

func (*Header) Reset

func (x *Header) Reset()

func (*Header) String

func (x *Header) String() string

type OutOfBagTrainingEvaluations

type OutOfBagTrainingEvaluations struct {

	// Number of trees available in the model when evaluated.
	NumberOfTrees *int32                    `protobuf:"varint,1,opt,name=number_of_trees,json=numberOfTrees" json:"number_of_trees,omitempty"`
	Evaluation    *proto1.EvaluationResults `protobuf:"bytes,2,opt,name=evaluation" json:"evaluation,omitempty"`
	// contains filtered or unexported fields
}

func (*OutOfBagTrainingEvaluations) Descriptor

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

Deprecated: Use OutOfBagTrainingEvaluations.ProtoReflect.Descriptor instead.

func (*OutOfBagTrainingEvaluations) GetEvaluation

func (x *OutOfBagTrainingEvaluations) GetEvaluation() *proto1.EvaluationResults

func (*OutOfBagTrainingEvaluations) GetNumberOfTrees

func (x *OutOfBagTrainingEvaluations) GetNumberOfTrees() int32

func (*OutOfBagTrainingEvaluations) ProtoMessage

func (*OutOfBagTrainingEvaluations) ProtoMessage()

func (*OutOfBagTrainingEvaluations) ProtoReflect

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

func (*OutOfBagTrainingEvaluations) Reset

func (x *OutOfBagTrainingEvaluations) Reset()

func (*OutOfBagTrainingEvaluations) String

func (x *OutOfBagTrainingEvaluations) String() string