model

Documentation

Overview

Package model defines the "Model" interface.

Index

• Variables
• type Implementation
• type Model

Variables

var RegisteredBuilders = make(map[string]func(header *model_pb.AbstractModel, dataspec *dataspec_pb.DataSpecification) Implementation)

RegisteredBuilders is the list of model builders, keyed by a unique `ModelKey` string per model type. Only register (change) this during the runtime initialization, in `init()` function. End users probably want to use `io.LoadModel()` to load models instead.

Types

type Implementation

type Implementation interface {
	Model

	// LoadSpecific loads the model implementation specific data from a directory.
	// Users are not expected to call this method directly. Instead, models
	// should be loaded with "model, err := io.LoadModel(path)".
	LoadSpecific(modelPath string, prefix string) error
}

Implementation interface needs to be implemented by Models (mostly internal). Not needed by those only using a model.

type Model

type Model interface {

	// Registered name of the model.
	Name() string

	// Header of the model.
	Header() *model_pb.AbstractModel

	// Dataspec of the model.
	Dataspec() *dataspec_pb.DataSpecification
}

Model is a generic model interface.

Examples:

// Create a new GBT model model := gradientboostedtrees.Create(...)

// Load an existing model. model, err := io.Load("/path/to/model") fmt.Println("My model is a %v.", model.Name()) >> My model is a GRADIENT_BOOSTED_TREES.