successivehalving

Documentation

Index

• Variables
• type Option
  • func OptionMinEarlyStoppingRate(minEarlyStoppingRate int) Option
  • func OptionMinResource(minResource int) Option
  • func OptionReductionFactor(reductionFactor int) Option
• type Pruner
  • func NewPruner(opts ...Option) (*Pruner, error)
  • func (p *Pruner) Prune(study *goptuna.Study, trial goptuna.FrozenTrial) (bool, error)

Variables

var OptionSetMinEarlyStoppingRate = OptionMinEarlyStoppingRate

OptionSetMinEarlyStoppingRate to set the minimum value of the early stopping rate. Deprecated: please use OptionMinEarlyStoppingRate instead.

var OptionSetMinResource = OptionMinResource

OptionSetMinResource to set the minimum resource. Deprecated: please use OptionMinResource instead.

var OptionSetReductionFactor = OptionReductionFactor

OptionSetReductionFactor to set the reduction factor. Deprecated: please use OptionReductionFactor instead.

Types

type Option

type Option func(pruner *Pruner) error

Option to pass the custom option

func OptionMinEarlyStoppingRate

func OptionMinEarlyStoppingRate(minEarlyStoppingRate int) Option

OptionMinEarlyStoppingRate to set the minimum value of the early stopping rate.

func OptionMinResource

func OptionMinResource(minResource int) Option

OptionMinResource to set the minimum resource.

func OptionReductionFactor

func OptionReductionFactor(reductionFactor int) Option

OptionReductionFactor to set the reduction factor.

type Pruner

type Pruner struct {
	MinResource          int
	ReductionFactor      int
	MinEarlyStoppingRate int
}

Pruner using Optuna flavored Asynchronous Successive Halving Algorithm.

Successive Halving (arXiv: https://arxiv.org/abs/1502.07943) is a bandit-based algorithm to identify the best one among multiple configurations. This is based on Asynchronous Successive Halving Algorithm (arXiv: http://arxiv.org/abs/1810.05934), but currently this only supports Optuna flavored Asynchronous Successive Halving Algorithm. See https://github.com/optuna/optuna/pull/404 for more details.

func NewPruner

func NewPruner(opts ...Option) (*Pruner, error)

NewPruner is a constructor for Pruner.

func (*Pruner) Prune

func (p *Pruner) Prune(study *goptuna.Study, trial goptuna.FrozenTrial) (bool, error)