successivehalving

Documentation

Index

• type Option
  • func OptionSetMinEarlyStoppingRate(minEarlyStoppingRate int) Option
  • func OptionSetMinResource(minResource int) Option
  • func OptionSetReductionFactor(reductionFactor int) Option
• type Pruner
  • func NewPruner(opts ...Option) (*Pruner, error)
  • func (p *Pruner) Prune(study *goptuna.Study, trial goptuna.FrozenTrial) (bool, error)

Types

type Option

type Option func(pruner *Pruner) error

Option to pass the custom option

func OptionSetMinEarlyStoppingRate

func OptionSetMinEarlyStoppingRate(minEarlyStoppingRate int) Option

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

func OptionSetMinResource

func OptionSetMinResource(minResource int) Option

OptionSetMinResource to set the minimum resource.

func OptionSetReductionFactor

func OptionSetReductionFactor(reductionFactor int) Option

OptionSetReductionFactor 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)