goptuna

package module

Go to main page

Versions in this module

v0

v0.9.0

Sep 9, 2023

v0.8.1

Apr 23, 2021

v0.8.0

Feb 9, 2021

v0.7.1

Oct 28, 2020

v0.7.0

Oct 21, 2020

v0.6.0

Jul 28, 2020

Changes in this version

+ var ErrDeleteNonFinishedTrial = errors.New("non finished trial is deleted")

+ var ErrTrialAlreadyDeleted = errors.New("trial is already deleted")

+ var ErrTrialsPartiallyDeleted = errors.New("some trials are already deleted")

+ type BlackHoleStorage struct

+ func NewBlackHoleStorage(n int) *BlackHoleStorage

+ func (s *BlackHoleStorage) CloneTrial(studyID int, baseTrial FrozenTrial) (int, error)

+ func (s *BlackHoleStorage) CreateNewStudy(name string) (int, error)

+ func (s *BlackHoleStorage) CreateNewTrial(studyID int) (int, error)

+ func (s *BlackHoleStorage) DeleteStudy(studyID int) error

+ func (s *BlackHoleStorage) GetAllStudySummaries() ([]StudySummary, error)

+ func (s *BlackHoleStorage) GetAllTrials(studyID int) ([]FrozenTrial, error)

+ func (s *BlackHoleStorage) GetBestTrial(studyID int) (FrozenTrial, error)

+ func (s *BlackHoleStorage) GetStudyDirection(studyID int) (StudyDirection, error)

+ func (s *BlackHoleStorage) GetStudyIDFromName(name string) (int, error)

+ func (s *BlackHoleStorage) GetStudyIDFromTrialID(trialID int) (int, error)

+ func (s *BlackHoleStorage) GetStudyNameFromID(studyID int) (string, error)

+ func (s *BlackHoleStorage) GetStudySystemAttrs(studyID int) (map[string]string, error)

+ func (s *BlackHoleStorage) GetStudyUserAttrs(studyID int) (map[string]string, error)

+ func (s *BlackHoleStorage) GetTrial(trialID int) (FrozenTrial, error)

+ func (s *BlackHoleStorage) GetTrialNumberFromID(trialID int) (int, error)

+ func (s *BlackHoleStorage) GetTrialParam(trialID int, paramName string) (float64, error)

+ func (s *BlackHoleStorage) GetTrialParams(trialID int) (map[string]interface{}, error)

+ func (s *BlackHoleStorage) GetTrialSystemAttrs(trialID int) (map[string]string, error)

+ func (s *BlackHoleStorage) GetTrialUserAttrs(trialID int) (map[string]string, error)

+ func (s *BlackHoleStorage) SetStudyDirection(studyID int, direction StudyDirection) error

+ func (s *BlackHoleStorage) SetStudySystemAttr(studyID int, key string, value string) error

+ func (s *BlackHoleStorage) SetStudyUserAttr(studyID int, key string, value string) error

+ func (s *BlackHoleStorage) SetTrialIntermediateValue(trialID int, step int, value float64) error

+ func (s *BlackHoleStorage) SetTrialParam(trialID int, paramName string, paramValueInternal float64, ...) error

+ func (s *BlackHoleStorage) SetTrialState(trialID int, state TrialState) error

+ func (s *BlackHoleStorage) SetTrialSystemAttr(trialID int, key string, value string) error

+ func (s *BlackHoleStorage) SetTrialUserAttr(trialID int, key string, value string) error

+ func (s *BlackHoleStorage) SetTrialValue(trialID int, value float64) error

+ type RandomSampler struct

+ func NewRandomSampler(opts ...RandomSamplerOption) *RandomSampler

+ func (s *RandomSampler) Sample(study *Study, trial FrozenTrial, paramName string, ...) (float64, error)

+ type RandomSamplerOption func(sampler *RandomSampler)

+ func RandomSamplerOptionSeed(seed int64) RandomSamplerOption

type StudyOption

+ func StudyOptionDirection(direction StudyDirection) StudyOption

+ func StudyOptionTrialNotifyChannel(notify chan FrozenTrial) StudyOption

v0.5.1

Apr 10, 2020

Changes in this version

type StudyOption

+ func StudyOptionDefineSearchSpace(space map[string]interface{}) StudyOption

type Trial

+ func (t *Trial) CallRelativeSampler() error

v0.5.0

Apr 10, 2020

Changes in this version

+ const StepIntUniformDistributionName

+ type StepIntUniformDistribution struct

+ High int

+ Low int

+ Step int

+ func (d *StepIntUniformDistribution) Contains(ir float64) bool

+ func (d *StepIntUniformDistribution) Single() bool

+ func (d *StepIntUniformDistribution) ToExternalRepr(ir float64) interface{}

type Trial

+ func (t *Trial) SuggestDiscreteFloat(name string, low, high, q float64) (float64, error)

+ func (t *Trial) SuggestFloat(name string, low, high float64) (float64, error)

+ func (t *Trial) SuggestLogFloat(name string, low, high float64) (float64, error)

+ func (t *Trial) SuggestStepInt(name string, low, high, step int) (int, error)

v0.4.0

Mar 19, 2020

Changes in this version

type Study

+ func (s *Study) GetLogger() Logger

v0.3.0

Mar 11, 2020

Changes in this version

type FrozenTrial

+ InternalParams map[string]float64

type InMemoryStorage

+ func (s *InMemoryStorage) CloneTrial(studyID int, baseTrial FrozenTrial) (int, error)

type Storage

+ CloneTrial func(studyID int, baseTrial FrozenTrial) (int, error)

type Study

+ func (s *Study) EnqueueTrial(internalParams map[string]float64) error

type TrialState

+ const TrialStateWaiting

v0.2.0

Mar 10, 2020

Changes in this version

+ var ErrUnsupportedSearchSpace = errors.New("unsupported search space")

+ func DeleteStudy(name string, storage Storage) error

+ func DistributionIsSingle(distribution interface{}) (bool, error)

+ func IntersectionSearchSpace(study *Study) (map[string]interface{}, error)

type FrozenTrial

+ func (t FrozenTrial) GetLatestStep() (step int, exist bool)

type InMemoryStorage

+ func (s *InMemoryStorage) CreateNewStudy(name string) (int, error)

+ func (s *InMemoryStorage) CreateNewTrial(studyID int) (int, error)

+ func (s *InMemoryStorage) DeleteStudy(studyID int) error

+ type RelativeSampler interface

+ SampleRelative func(*Study, FrozenTrial, map[string]interface{}) (map[string]float64, error)

type Storage

+ CreateNewStudy func(name string) (int, error)

+ CreateNewTrial func(studyID int) (int, error)

+ DeleteStudy func(studyID int) error

type Study

+ RelativeSampler RelativeSampler

type StudyOption

+ func StudyOptionLoadIfExists(loadIfExists bool) StudyOption

+ func StudyOptionRelativeSampler(sampler RelativeSampler) StudyOption

v0.1.0

Aug 21, 2019

Changes in this version

+ func ToInternalRepresentation(distribution interface{}, xr interface{}) (float64, error)

+ type Logger interface

+ Debug func(msg string, fields ...interface{})

+ Error func(msg string, fields ...interface{})

+ Info func(msg string, fields ...interface{})

+ Warn func(msg string, fields ...interface{})

+ type LoggerLevel int

+ const LoggerLevelDebug

+ const LoggerLevelError

+ const LoggerLevelInfo

+ const LoggerLevelWarn

+ type StdLogger struct

+ Color bool

+ Level LoggerLevel

+ Logger *log.Logger

+ func (l *StdLogger) Debug(msg string, fields ...interface{})

+ func (l *StdLogger) Error(msg string, fields ...interface{})

+ func (l *StdLogger) Info(msg string, fields ...interface{})

+ func (l *StdLogger) Warn(msg string, fields ...interface{})

type StudyOption

+ func StudyOptionIgnoreError(ignore bool) StudyOption

+ func StudyOptionLogger(logger Logger) StudyOption

v0.0.4

Aug 14, 2019

Changes in this version

+ func ToExternalRepresentation(distribution interface{}, ir float64) (interface{}, error)

type Study

+ func LoadStudy(name string, opts ...StudyOption) (*Study, error)

+ func (s *Study) GetSystemAttrs() (map[string]string, error)

+ func (s *Study) GetUserAttrs() (map[string]string, error)

+ func (s *Study) SetSystemAttr(key, value string) error

+ func (s *Study) SetUserAttr(key, value string) error

type Trial

+ func (t *Trial) GetContext() context.Context

+ func (t *Trial) GetSystemAttrs() (map[string]string, error)

+ func (t *Trial) GetUserAttrs() (map[string]string, error)

+ func (t *Trial) SetSystemAttr(key, value string) error

+ func (t *Trial) SetUserAttr(key, value string) error

+ func (t *Trial) SuggestDiscreteUniform(name string, low, high, q float64) (float64, error)

+ func (t *Trial) SuggestLogUniform(name string, low, high float64) (float64, error)

v0.0.3

Aug 5, 2019

Changes in this version

+ const DiscreteUniformDistributionName

+ const LogUniformDistributionName

+ var ErrTrialCannotBeUpdated = errors.New("trial cannot be updated")

+ var ErrTrialPruned = errors.New("trial is pruned")

+ type DiscreteUniformDistribution struct

+ High float64

+ Low float64

+ Q float64

+ func (d *DiscreteUniformDistribution) Contains(ir float64) bool

+ func (d *DiscreteUniformDistribution) Single() bool

+ func (d *DiscreteUniformDistribution) ToExternalRepr(ir float64) interface{}

+ func (d *DiscreteUniformDistribution) ToInternalRepr(xr interface{}) float64

type FrozenTrial

+ IntermediateValues map[int]float64

type InMemoryStorage

+ func (s *InMemoryStorage) SetTrialIntermediateValue(trialID int, step int, value float64) error

+ type LogUniformDistribution struct

+ High float64

+ Low float64

+ func (d *LogUniformDistribution) Contains(ir float64) bool

+ func (d *LogUniformDistribution) Single() bool

+ func (d *LogUniformDistribution) ToExternalRepr(ir float64) interface{}

+ func (d *LogUniformDistribution) ToInternalRepr(xr interface{}) float64

+ type Pruner interface

+ Prune func(storage Storage, studyID, trialID int, step int) (bool, error)

type Storage

+ SetTrialIntermediateValue func(trialID int, step int, value float64) error

type Study

+ ID int

+ Pruner Pruner

+ Sampler Sampler

+ Storage Storage

type StudyOption

+ func StudyOptionPruner(pruner Pruner) StudyOption

type Trial

+ ID int

+ Study *Study

+ func (t *Trial) Number() (int, error)

+ func (t *Trial) Report(value float64, step int) error

+ func (t *Trial) ShouldPrune(value float64) (bool, error)

v0.0.2

Jul 29, 2019

Changes in this version

+ const CategoricalDistributionName

+ const InMemoryStorageStudyID

+ const InMemoryStorageStudyUUID

+ const IntUniformDistributionName

+ const UniformDistributionName

+ var DefaultStudyNamePrefix = "no-name-"

+ var ErrNotFound = errors.New("not found")

+ var ErrUnknownDistribution = errors.New("unknown distribution")

+ func DistributionToJSON(distribution interface{}) ([]byte, error)

+ func JSONToDistribution(jsonBytes []byte) (interface{}, error)

+ type CategoricalDistribution struct

+ Choices []string

+ func (d *CategoricalDistribution) Contains(ir float64) bool

+ func (d *CategoricalDistribution) Single() bool

+ func (d *CategoricalDistribution) ToExternalRepr(ir float64) interface{}

+ func (d *CategoricalDistribution) ToInternalRepr(er interface{}) float64

type Distribution

+ Contains func(float64) bool

+ Single func() bool

+ ToExternalRepr func(float64) interface{}

+ ToInternalRepr func(interface{}) float64

type FrozenTrial

+ DatetimeComplete time.Time

+ DatetimeStart time.Time

+ Distributions map[string]Distribution

+ Number int

+ Params map[string]interface{}

+ SystemAttrs map[string]interface{}

+ UserAttrs map[string]interface{}

type InMemoryStorage

+ func (s *InMemoryStorage) GetAllStudySummaries(studyID int) ([]StudySummary, error)

+ func (s *InMemoryStorage) GetStudyIDFromName(name string) (int, error)

+ func (s *InMemoryStorage) GetStudyIDFromTrialID(trialID int) (int, error)

+ func (s *InMemoryStorage) GetStudyNameFromID(studyID int) (string, error)

+ func (s *InMemoryStorage) GetStudySystemAttrs(studyID int) (map[string]interface{}, error)

+ func (s *InMemoryStorage) GetStudyUserAttrs(studyID int) (map[string]interface{}, error)

+ func (s *InMemoryStorage) GetTrialNumberFromID(trialID int) (int, error)

+ func (s *InMemoryStorage) GetTrialParam(trialID int, paramName string) (float64, error)

+ func (s *InMemoryStorage) GetTrialParams(trialID int) (map[string]interface{}, error)

+ func (s *InMemoryStorage) GetTrialSystemAttrs(trialID int) (map[string]interface{}, error)

+ func (s *InMemoryStorage) GetTrialUserAttrs(trialID int) (map[string]interface{}, error)

+ func (s *InMemoryStorage) SetStudySystemAttr(studyID int, key string, value interface{}) error

+ func (s *InMemoryStorage) SetStudyUserAttr(studyID int, key string, value interface{}) error

+ func (s *InMemoryStorage) SetTrialSystemAttr(trialID int, key string, value interface{}) error

+ func (s *InMemoryStorage) SetTrialUserAttr(trialID int, key string, value interface{}) error

type IntUniformDistribution

+ func (d *IntUniformDistribution) Contains(ir float64) bool

+ func (d *IntUniformDistribution) Single() bool

+ func (d *IntUniformDistribution) ToExternalRepr(ir float64) interface{}

+ func (d *IntUniformDistribution) ToInternalRepr(xr interface{}) float64

type Storage

+ GetAllStudySummaries func(studyID int) ([]StudySummary, error)

+ GetStudyIDFromName func(name string) (int, error)

+ GetStudyIDFromTrialID func(trialID int) (int, error)

+ GetStudyNameFromID func(studyID int) (string, error)

+ GetStudySystemAttrs func(studyID int) (map[string]interface{}, error)

+ GetStudyUserAttrs func(studyID int) (map[string]interface{}, error)

+ GetTrialNumberFromID func(trialID int) (int, error)

+ GetTrialParam func(trialID int, paramName string) (float64, error)

+ GetTrialParams func(trialID int) (map[string]interface{}, error)

+ GetTrialSystemAttrs func(trialID int) (map[string]interface{}, error)

+ GetTrialUserAttrs func(trialID int) (map[string]interface{}, error)

+ SetStudySystemAttr func(studyID int, key string, value interface{}) error

+ SetStudyUserAttr func(studyID int, key string, value interface{}) error

+ SetTrialSystemAttr func(trialID int, key string, value interface{}) error

+ SetTrialUserAttr func(trialID int, key string, value interface{}) error

type Study

+ func (s *Study) WithContext(ctx context.Context)

+ type StudySummary struct

+ BestTrial FrozenTrial

+ DatetimeStart time.Time

+ Direction StudyDirection

+ ID int

+ Name string

+ SystemAttrs map[string]interface{}

+ UserAttrs map[string]interface{}

type Trial

+ func (t *Trial) SuggestCategorical(name string, choices []string) (string, error)

type UniformDistribution

+ High float64

+ Low float64

+ func (d *UniformDistribution) Contains(ir float64) bool

+ func (d *UniformDistribution) Single() bool

+ func (d *UniformDistribution) ToExternalRepr(ir float64) interface{}

+ func (d *UniformDistribution) ToInternalRepr(xr interface{}) float64

v0.0.1

Jul 25, 2019

Changes in this version

+ const InMemoryStorageStudyId

+ var ErrInvalidStudyID = errors.New("invalid study id")

+ var ErrInvalidTrialID = errors.New("invalid trial id")

+ var ErrNoCompletedTrials = errors.New("no trials are completed yet")

+ var ErrTrialIsNotUpdated = errors.New("trial cannot be updated")

+ var ErrUnexpectedDistribution = errors.New("unexpected distribution")

+ type Distribution interface

+ GetName func() string

+ type FrozenTrial struct

+ ID string

+ ParamsInIR map[string]float64

+ State TrialState

+ StudyID string

+ Value float64

+ type FuncObjective func(trial Trial) (float64, error)

+ type InMemoryStorage struct

+ func NewInMemoryStorage() *InMemoryStorage

+ func (s *InMemoryStorage) CreateNewStudyID(name string) (string, error)

+ func (s *InMemoryStorage) CreateNewTrialID(studyID string) (string, error)

+ func (s *InMemoryStorage) GetAllTrials(studyID string) ([]FrozenTrial, error)

+ func (s *InMemoryStorage) GetBestTrial(studyID string) (FrozenTrial, error)

+ func (s *InMemoryStorage) GetStudyDirection(studyID string) (StudyDirection, error)

+ func (s *InMemoryStorage) GetTrial(trialID string) (FrozenTrial, error)

+ func (s *InMemoryStorage) SetStudyDirection(studyID string, direction StudyDirection) error

+ func (s *InMemoryStorage) SetTrialParam(trialID string, paramName string, paramValueInternal float64) error

+ func (s *InMemoryStorage) SetTrialState(trialID string, state TrialState) error

+ func (s *InMemoryStorage) SetTrialValue(trialID string, value float64) error

+ type IntUniformDistribution struct

+ High int

+ Low int

+ Name string

+ func (d *IntUniformDistribution) GetName() string

+ type RandomSearchSampler struct

+ func NewRandomSearchSampler(opts ...RandomSearchSamplerOption) *RandomSearchSampler

+ func (s *RandomSearchSampler) Sample(study *Study, trial FrozenTrial, paramName string, ...) (float64, error)

+ type RandomSearchSamplerOption func(sampler *RandomSearchSampler)

+ func RandomSearchSamplerOptionSeed(seed int64) RandomSearchSamplerOption

+ type Sampler interface

+ Sample func(*Study, FrozenTrial, string, interface{}) (float64, error)

+ type Storage interface

+ CreateNewStudyID func(name string) (string, error)

+ CreateNewTrialID func(studyID string) (string, error)

+ GetAllTrials func(studyID string) ([]FrozenTrial, error)

+ GetBestTrial func(studyID string) (FrozenTrial, error)

+ GetStudyDirection func(studyID string) (StudyDirection, error)

+ GetTrial func(trialID string) (FrozenTrial, error)

+ SetStudyDirection func(studyID string, direction StudyDirection) error

+ SetTrialParam func(trialID string, paramName string, paramValueInternal float64) error

+ SetTrialState func(trialID string, state TrialState) error

+ SetTrialValue func(trialID string, value float64) error

+ type Study struct

+ func CreateStudy(name string, opts ...StudyOption) (*Study, error)

+ func (s *Study) Direction() StudyDirection

+ func (s *Study) GetBestParams() (map[string]float64, error)

+ func (s *Study) GetBestValue() (float64, error)

+ func (s *Study) GetTrials() ([]FrozenTrial, error)

+ func (s *Study) Optimize(objective FuncObjective, evaluateMax int) error

+ func (s *Study) Report(trialID string, value float64) error

+ type StudyDirection string

+ const StudyDirectionMaximize

+ const StudyDirectionMinimize

+ type StudyOption func(study *Study) error

+ func StudyOptionIgnoreObjectiveErr(ignore bool) StudyOption

+ func StudyOptionSampler(sampler Sampler) StudyOption

+ func StudyOptionSetDirection(direction StudyDirection) StudyOption

+ func StudyOptionSetLogger(logger *zap.Logger) StudyOption

+ func StudyOptionSetTrialNotifyChannel(notify chan FrozenTrial) StudyOption

+ func StudyOptionStorage(storage Storage) StudyOption

+ type Trial struct

+ func (t *Trial) Frozen() FrozenTrial

+ func (t *Trial) SuggestInt(name string, low, high int) (int, error)

+ func (t *Trial) SuggestUniform(name string, low, high float64) (float64, error)

+ type TrialState int

+ const TrialStateComplete

+ const TrialStateFail

+ const TrialStatePruned

+ const TrialStateRunning

+ func (i TrialState) String() string

+ func (t TrialState) IsFinished() bool

+ type UniformDistribution struct

+ Max float64

+ Min float64

+ Name string

+ func (d *UniformDistribution) GetName() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL