Skip to content

optuna 4.8.0

Version history | Download JSON

  • PyPI https://pypi.org/project/optuna/
    Repository https://github.com/optuna/optuna

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 2035
    "Any" : 57
    "Untyped" : 73
    • 96.6% coverage
    • 94.0% coverage (strict)
    • 2165 typable
      • 2035 typed
      • 73 untyped
      • 57 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 204
    "classes" : 1877
    "other" : 25
    • 51 functions (+0 overloads)
      • 153 parameters
    • 106 classes
      • 620 methods (+20 overloads)
        • 1201 parameters
      • 47 properties
    • 134 modules
      • 25 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
optuna._callbacks 100.0% 100.0% 6 0
optuna.artifacts._backoff 100.0% 100.0% 15 0
optuna.artifacts._boto3 84.6% 84.6% 13 0
optuna.artifacts._download 100.0% 100.0% 4 0
optuna.artifacts._filesystem 100.0% 100.0% 11 0
optuna.artifacts._gcs 76.9% 76.9% 13 0
optuna.artifacts._list_artifact_meta 100.0% 100.0% 3 0
optuna.artifacts._upload 100.0% 100.0% 7 0
optuna.artifacts.exceptions 0.0% 0.0% 0 0
optuna.cli 80.0% 70.0% 10 0
optuna.distributions 89.7% 85.1% 87 0
optuna.exceptions 0.0% 0.0% 0 0
optuna.importance 100.0% 100.0% 6 0
optuna.importance._base 100.0% 100.0% 4 0
optuna.importance._fanova._evaluator 100.0% 100.0% 8 0
optuna.importance._mean_decrease_impurity 100.0% 100.0% 8 0
optuna.importance._ped_anova.evaluator 100.0% 100.0% 19 0
optuna.integration 0.0% 0.0% 3 0
optuna.integration.allennlp 0.0% 0.0% 0 0
optuna.integration.botorch 0.0% 0.0% 0 0
optuna.integration.catboost 0.0% 0.0% 0 0
optuna.integration.chainer 0.0% 0.0% 0 0
optuna.integration.chainermn 0.0% 0.0% 0 0
optuna.integration.cma 0.0% 0.0% 0 0
optuna.integration.dask 0.0% 0.0% 0 0
optuna.integration.fastaiv2 0.0% 0.0% 0 0
optuna.integration.keras 0.0% 0.0% 0 0
optuna.integration.lightgbm 0.0% 0.0% 4 0
optuna.integration.mlflow 0.0% 0.0% 0 0
optuna.integration.mxnet 0.0% 0.0% 0 0
optuna.integration.pytorch_distributed 0.0% 0.0% 0 0
optuna.integration.pytorch_ignite 0.0% 0.0% 0 0
optuna.integration.pytorch_lightning 0.0% 0.0% 0 0
optuna.integration.shap 0.0% 0.0% 0 0
optuna.integration.sklearn 0.0% 0.0% 0 0
optuna.integration.skorch 0.0% 0.0% 0 0
optuna.integration.tensorboard 0.0% 0.0% 0 0
optuna.integration.tensorflow 0.0% 0.0% 0 0
optuna.integration.tfkeras 0.0% 0.0% 0 0
optuna.integration.wandb 0.0% 0.0% 0 0
optuna.integration.xgboost 0.0% 0.0% 0 0
optuna.logging 0.0% 0.0% 0 0
optuna.multi_objective 0.0% 0.0% 0 0
optuna.pruners._base 100.0% 100.0% 3 0
optuna.pruners._hyperband 100.0% 100.0% 18 0
optuna.pruners._median 100.0% 100.0% 5 0
optuna.pruners._nop 100.0% 100.0% 3 0
optuna.pruners._patient 100.0% 100.0% 7 0
optuna.pruners._percentile 100.0% 100.0% 9 0
optuna.pruners._successive_halving 100.0% 100.0% 8 0
optuna.pruners._threshold 100.0% 100.0% 8 0
optuna.pruners._wilcoxon 100.0% 100.0% 6 0
optuna.samplers._base 100.0% 95.8% 24 0
optuna.samplers._brute_force 100.0% 95.8% 24 0
optuna.samplers._cmaes 100.0% 98.2% 55 0
optuna.samplers._ga._base 90.0% 85.0% 20 0
optuna.samplers._gp.sampler 100.0% 98.0% 49 0
optuna.samplers._grid 100.0% 94.4% 36 0
optuna.samplers._nsgaiii._sampler 100.0% 97.3% 37 0
optuna.samplers._partial_fixed 100.0% 95.8% 24 0
optuna.samplers._qmc 100.0% 97.4% 39 0
optuna.samplers._random 100.0% 93.3% 15 0
optuna.samplers._tpe.sampler 100.0% 98.4% 63 0
optuna.samplers.nsgaii._crossovers._base 100.0% 100.0% 7 0
optuna.samplers.nsgaii._crossovers._blxalpha 100.0% 100.0% 7 0
optuna.samplers.nsgaii._crossovers._sbx 100.0% 100.0% 9 0
optuna.samplers.nsgaii._crossovers._spx 100.0% 100.0% 7 0
optuna.samplers.nsgaii._crossovers._undx 100.0% 100.0% 15 0
optuna.samplers.nsgaii._crossovers._uniform 100.0% 100.0% 7 0
optuna.samplers.nsgaii._crossovers._vsbx 100.0% 100.0% 9 0
optuna.samplers.nsgaii._sampler 100.0% 97.1% 35 0
optuna.search_space.group_decomposed 100.0% 100.0% 9 0
optuna.search_space.intersection 100.0% 100.0% 8 0
optuna.storages._base 100.0% 97.4% 77 0
optuna.storages._cached_storage 100.0% 97.4% 77 0
optuna.storages._callbacks 100.0% 100.0% 10 0
optuna.storages._grpc.client 100.0% 94.0% 67 0
optuna.storages._grpc.server 100.0% 100.0% 5 0
optuna.storages._heartbeat 100.0% 100.0% 2 0
optuna.storages._in_memory 100.0% 97.6% 83 0
optuna.storages._rdb.storage 94.6% 92.6% 149 0
optuna.storages.journal._base 100.0% 100.0% 4 0
optuna.storages.journal._file 89.5% 89.5% 19 0
optuna.storages.journal._redis 100.0% 100.0% 16 0
optuna.storages.journal._storage 100.0% 97.1% 68 0
optuna.study._study_direction 0.0% 0.0% 0 0
optuna.study._study_summary 75.0% 62.5% 24 0
optuna.study.study 97.0% 95.0% 101 0
optuna.terminator.callback 100.0% 100.0% 5 0
optuna.terminator.erroreval 100.0% 100.0% 14 0
optuna.terminator.improvement.emmr 53.3% 53.3% 15 0
optuna.terminator.improvement.evaluator 82.1% 82.1% 28 0
optuna.terminator.median_erroreval 100.0% 100.0% 8 0
optuna.terminator.terminator 100.0% 100.0% 9 0
optuna.testing.objectives 100.0% 100.0% 4 0
optuna.testing.pruners 83.3% 83.3% 6 0
optuna.testing.pytest_samplers 95.6% 92.6% 68 0
optuna.testing.pytest_storages 98.0% 98.0% 98 0
optuna.testing.samplers 93.3% 86.7% 15 0
optuna.testing.storages 85.7% 81.0% 21 0
optuna.testing.tempfile_pool 92.3% 84.6% 13 0
optuna.testing.visualization 100.0% 100.0% 4 0
optuna.trial._base 100.0% 95.5% 44 0
optuna.trial._fixed 100.0% 94.0% 50 0
optuna.trial._frozen 95.8% 89.5% 95 0
optuna.trial._state 100.0% 100.0% 1 0
optuna.trial._trial 96.9% 92.2% 64 0
optuna.version 0.0% 0.0% 0 0
optuna.visualization._contour 100.0% 100.0% 5 0
optuna.visualization._edf 100.0% 100.0% 4 0
optuna.visualization._hypervolume_history 100.0% 100.0% 3 0
optuna.visualization._intermediate_values 100.0% 100.0% 2 0
optuna.visualization._optimization_history 100.0% 100.0% 5 0
optuna.visualization._parallel_coordinate 100.0% 100.0% 5 0
optuna.visualization._param_importances 100.0% 100.0% 6 0
optuna.visualization._pareto_front 100.0% 100.0% 7 0
optuna.visualization._rank 100.0% 100.0% 5 0
optuna.visualization._slice 100.0% 100.0% 5 0
optuna.visualization._terminator_improvement 100.0% 100.0% 6 0
optuna.visualization._timeline 100.0% 100.0% 3 0
optuna.visualization._utils 100.0% 100.0% 1 0
optuna.visualization.matplotlib._contour 100.0% 100.0% 5 0
optuna.visualization.matplotlib._edf 100.0% 100.0% 4 0
optuna.visualization.matplotlib._hypervolume_history 100.0% 100.0% 3 0
optuna.visualization.matplotlib._intermediate_values 100.0% 100.0% 2 0
optuna.visualization.matplotlib._optimization_history 100.0% 100.0% 5 0
optuna.visualization.matplotlib._parallel_coordinate 100.0% 100.0% 5 0
optuna.visualization.matplotlib._param_importances 100.0% 100.0% 6 0
optuna.visualization.matplotlib._pareto_front 100.0% 100.0% 7 0
optuna.visualization.matplotlib._rank 100.0% 100.0% 5 0
optuna.visualization.matplotlib._slice 100.0% 100.0% 5 0
optuna.visualization.matplotlib._terminator_improvement 100.0% 100.0% 6 0
optuna.visualization.matplotlib._timeline 100.0% 100.0% 3 0
optuna.visualization.matplotlib._utils 100.0% 100.0% 1 0

Incomplete Annotations

optuna.artifacts._boto3 (2 missing, 0 any)

Symbol Typable Typed Any
attr Boto3ArtifactStore.bucket 1 0 0
attr Boto3ArtifactStore.client 1 0 0

optuna.artifacts._gcs (3 missing, 0 any)

Symbol Typable Typed Any
attr GCSArtifactStore.bucket_name 1 0 0
attr GCSArtifactStore.client 1 0 0
attr GCSArtifactStore.bucket_obj 1 0 0

optuna.cli (2 missing, 1 any)

Symbol Typable Typed Any
meth CellValue.init 2 2 1
attr CellValue.value 1 0 0
attr CellValue.value_type 1 0 0

optuna.distributions (9 missing, 4 any)

Symbol Typable Typed Any
meth CategoricalDistribution.eq 2 2 1
attr CategoricalDistribution.choices 1 0 0
attr IntDistribution.log 1 0 0
attr IntDistribution.step 1 0 0
attr IntDistribution.low 1 0 0
attr IntDistribution.high 1 0 0
meth BaseDistribution.to_external_repr 2 2 1
meth BaseDistribution.to_internal_repr 2 2 1
meth BaseDistribution.eq 2 2 1
attr FloatDistribution.step 1 0 0
attr FloatDistribution.low 1 0 0
attr FloatDistribution.high 1 0 0
attr FloatDistribution.log 1 0 0

optuna.integration (3 missing, 0 any)

Symbol Typable Typed Any
attr LightGBMTuner 1 0 0
attr LightGBMTunerCV 1 0 0
attr LightGBMPruningCallback 1 0 0

optuna.integration.lightgbm (4 missing, 0 any)

Symbol Typable Typed Any
attr train 1 0 0
attr LightGBMTuner 1 0 0
attr LightGBMTunerCV 1 0 0
attr LightGBMPruningCallback 1 0 0

optuna.samplers._base (0 missing, 1 any)

Symbol Typable Typed Any
meth BaseSampler.sample_independent 5 5 1

optuna.samplers._brute_force (0 missing, 1 any)

Symbol Typable Typed Any
meth BruteForceSampler.sample_independent 5 5 1

optuna.samplers._cmaes (0 missing, 1 any)

Symbol Typable Typed Any
meth CmaEsSampler.sample_independent 5 5 1

optuna.samplers._ga._base (2 missing, 1 any)

Symbol Typable Typed Any
meth BaseGASampler.init_subclass 2 1 1
meth BaseGASampler.init 2 1 0

optuna.samplers._gp.sampler (0 missing, 1 any)

Symbol Typable Typed Any
meth GPSampler.sample_independent 5 5 1

optuna.samplers._grid (0 missing, 2 any)

Symbol Typable Typed Any
meth GridSampler.sample_independent 5 5 1
meth GridSampler._check_value 3 3 1

optuna.samplers._nsgaiii._sampler (0 missing, 1 any)

Symbol Typable Typed Any
meth NSGAIIISampler.sample_independent 5 5 1

optuna.samplers._partial_fixed (0 missing, 1 any)

Symbol Typable Typed Any
meth PartialFixedSampler.sample_independent 5 5 1

optuna.samplers._qmc (0 missing, 1 any)

Symbol Typable Typed Any
meth QMCSampler.sample_independent 5 5 1

optuna.samplers._random (0 missing, 1 any)

Symbol Typable Typed Any
meth RandomSampler.sample_independent 5 5 1

optuna.samplers._tpe.sampler (0 missing, 1 any)

Symbol Typable Typed Any
meth TPESampler.sample_independent 5 5 1

optuna.samplers.nsgaii._sampler (0 missing, 1 any)

Symbol Typable Typed Any
meth NSGAIISampler.sample_independent 5 5 1

optuna.storages._base (0 missing, 2 any)

Symbol Typable Typed Any
meth BaseStorage.set_study_user_attr 4 4 1
meth BaseStorage.set_trial_user_attr 4 4 1

optuna.storages._cached_storage (0 missing, 2 any)

Symbol Typable Typed Any
meth _CachedStorage.set_study_user_attr 4 4 1
meth _CachedStorage.set_trial_user_attr 4 4 1

optuna.storages._grpc.client (0 missing, 4 any)

Symbol Typable Typed Any
meth GrpcStorageProxy.set_study_user_attr 4 4 1
meth GrpcStorageProxy.set_study_system_attr 4 4 1
meth GrpcStorageProxy.set_trial_user_attr 4 4 1
meth GrpcStorageProxy.set_trial_system_attr 4 4 1

optuna.storages._in_memory (0 missing, 2 any)

Symbol Typable Typed Any
meth InMemoryStorage.set_study_user_attr 4 4 1
meth InMemoryStorage.set_trial_user_attr 4 4 1

optuna.storages._rdb.storage (8 missing, 3 any)

Symbol Typable Typed Any
meth RDBStorage.set_study_user_attr 4 4 1
meth RDBStorage.set_trial_user_attr 4 4 1
meth RDBStorage._set_trial_attr_without_commit 6 6 1
attr RDBStorage.engine_kwargs 1 0 0
attr RDBStorage.url 1 0 0
attr RDBStorage.skip_compatibility_check 1 0 0
attr RDBStorage.heartbeat_interval 1 0 0
attr RDBStorage.grace_period 1 0 0
attr RDBStorage.failed_trial_callback 1 0 0
attr RDBStorage.scoped_session 1 0 0
attr RDBStorage.engine 1 0 0

optuna.storages.journal._file (2 missing, 0 any)

Symbol Typable Typed Any
attr JournalFileOpenLock.grace_period 1 0 0
attr JournalFileSymlinkLock.grace_period 1 0 0

optuna.storages.journal._storage (0 missing, 2 any)

Symbol Typable Typed Any
meth JournalStorage.set_study_user_attr 4 4 1
meth JournalStorage.set_trial_user_attr 4 4 1

optuna.study._study_summary (6 missing, 3 any)

Symbol Typable Typed Any
meth StudySummary.init 10 9 0
meth StudySummary.eq 2 2 1
meth StudySummary.lt 2 2 1
meth StudySummary.le 2 2 1
attr StudySummary.study_name 1 0 0
attr StudySummary.best_trial 1 0 0
attr StudySummary.user_attrs 1 0 0
attr StudySummary.n_trials 1 0 0
attr StudySummary.datetime_start 1 0 0

optuna.study.study (3 missing, 2 any)

Symbol Typable Typed Any
meth Study.set_user_attr 3 3 1
meth Study.set_system_attr 3 3 1
attr Study.study_name 1 0 0
attr Study.sampler 1 0 0
attr Study.pruner 1 0 0

optuna.terminator.improvement.emmr (7 missing, 0 any)

Symbol Typable Typed Any
attr EMMREvaluator.min_n_trials 1 0 0
attr scipy_stats 1 0 0
attr gp 1 0 0
attr torch 1 0 0
attr acqf_module 1 0 0
attr gp_search_space 1 0 0
attr prior 1 0 0

optuna.terminator.improvement.evaluator (5 missing, 0 any)

Symbol Typable Typed Any
attr optim_sample 1 0 0
attr gp 1 0 0
attr acqf_module 1 0 0
attr gp_search_space 1 0 0
attr prior 1 0 0

optuna.testing.pruners (1 missing, 0 any)

Symbol Typable Typed Any
attr DeterministicPruner.is_pruning 1 0 0

optuna.testing.pytest_samplers (3 missing, 2 any)

Symbol Typable Typed Any
meth FixedSampler.init 4 4 1
meth FixedSampler.sample_independent 5 5 1
attr FixedSampler.relative_search_space 1 0 0
attr FixedSampler.relative_params 1 0 0
attr FixedSampler.unknown_param_value 1 0 0

optuna.testing.pytest_storages (2 missing, 0 any)

Symbol Typable Typed Any
attr ALL_STATES 1 0 0
attr FLOAT_ATTRS 1 0 0

optuna.testing.samplers (1 missing, 1 any)

Symbol Typable Typed Any
meth DeterministicSampler.sample_independent 5 5 1
attr DeterministicSampler.params 1 0 0

optuna.testing.storages (3 missing, 1 any)

Symbol Typable Typed Any
attr grpc 1 0 0
meth StorageSupplier.init 3 3 1
attr StorageSupplier.storage_specifier 1 0 0
attr StorageSupplier.extra_args 1 0 0

optuna.testing.tempfile_pool (1 missing, 1 any)

Symbol Typable Typed Any
meth NamedTemporaryFilePool.init 2 2 1
attr NamedTemporaryFilePool.kwargs 1 0 0

optuna.trial._base (0 missing, 2 any)

Symbol Typable Typed Any
meth BaseTrial.set_user_attr 3 3 1
meth BaseTrial.set_system_attr 3 3 1

optuna.trial._fixed (0 missing, 3 any)

Symbol Typable Typed Any
meth FixedTrial.set_user_attr 3 3 1
meth FixedTrial.set_system_attr 3 3 1
meth FixedTrial._suggest 3 3 1

optuna.trial._frozen (4 missing, 6 any)

Symbol Typable Typed Any
meth FrozenTrial.eq 2 2 1
meth FrozenTrial.lt 2 2 1
meth FrozenTrial.le 2 2 1
meth FrozenTrial.set_user_attr 3 3 1
meth FrozenTrial.set_system_attr 3 3 1
meth FrozenTrial._suggest 3 3 1
attr FrozenTrial.state 1 0 0
attr FrozenTrial.datetime_complete 1 0 0
attr FrozenTrial.intermediate_values 1 0 0
attr FrozenTrial.values 1 0 0

optuna.trial._trial (2 missing, 3 any)

Symbol Typable Typed Any
meth Trial.set_user_attr 3 3 1
meth Trial.set_system_attr 3 3 1
meth Trial._suggest 3 3 1
attr Trial.study 1 0 0
attr Trial.storage 1 0 0

Type-Ignore Comments

No type-ignore comments.