efficacy

Documentation

Index

• type Field
  • func (f Field) String() string
• type Method
  • func (m Method) String() string
• type Sample
• type Sampler
  • func NewSampler(filename string) (*Sampler, error)
  • func (s *Sampler) Callbacks(num int) (start, complete evo.Callback)
  • func (s *Sampler) Close() error
  • func (s *Sampler) Record(sample Sample) error

Types

type Field

type Field byte

Field is the type of field being collected

const (
	BatchNumber Field = iota
	Began
	Ended
	Solved
	Generations
	Evaluations
	Seconds
	Fitness
	Novelty
	Encoded
	EncodedNodes
	EncodedConns
	Decoded
	DecodedNodes
	DecodedConns
)

Known fields

func (Field) String

func (f Field) String() string

String returns a text description of the field

type Method

type Method byte

Method is the aggregrate function

const (
	Min Method = iota
	Max
	Mean
	Median
	Best // values from the most fit genome
)

Known methods

func (Method) String

func (m Method) String() string

String provides the text description of the method

type Sample

type Sample struct {
	BatchNumber int
	Began       time.Time
	Ended       time.Time
	Solved      bool
	Generations int
	Evaluations int
	Seconds     float64
	Values      map[Field]map[Method]float64
}

Sample is the result of an evaluation run

type Sampler

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

Sampler records the results of an experiment's run

func NewSampler

func NewSampler(filename string) (*Sampler, error)

NewSampler creates a new efficacy sampler

func (*Sampler) Callbacks

func (s *Sampler) Callbacks(num int) (start, complete evo.Callback)

Callbacks returns a new listener callback function for the given batch number.

func (*Sampler) Close

func (s *Sampler) Close() error

Close the underlying writer returning any error from that action

func (*Sampler) Record

func (s *Sampler) Record(sample Sample) error

Record appends the sample to the file.