Welcome
User Guide
user_script_config
working_dir
uniform(low, high)
loguniform(low, high)
normal(loc, scale)
gaussian(loc, scale)
choices(options)
fidelity(low, high, base=2)
discrete
default_value
precision
shape
list
--name
status
--all
--collapse
info
--version
setup
test
rm
set
release
upgrade
Tutorials
Plugins
API Reference
Categorical
Categorical.cardinality
Categorical.cast()
Categorical.get_cardinality()
Categorical.get_prior
Categorical.get_prior_string()
Categorical.interval()
Categorical.prior_name
Categorical.sample()
Dimension
Dimension.cardinality
Dimension.cast()
Dimension.default_value
Dimension.get_prior_string()
Dimension.get_string()
Dimension.interval()
Dimension.name
Dimension.prior_name
Dimension.sample()
Dimension.shape
Dimension.type
Dimension.validate()
Fidelity
Fidelity.cardinality
Fidelity.cast()
Fidelity.default_value
Fidelity.get_cardinality()
Fidelity.get_prior_string()
Fidelity.interval()
Fidelity.sample()
Fidelity.validate()
Integer
Integer.cardinality
Integer.cast()
Integer.get_cardinality()
Integer.get_prior_string()
Integer.prior_name
Real
Real.cardinality
Real.cast()
Real.get_cardinality()
Real.get_prior_string()
Real.interval()
Real.sample()
Space
Space.assert_contains()
Space.cardinality
Space.configuration
Space.contains
Space.interval()
Space.items()
Space.keys()
Space.register()
Space.sample()
Space.values()
SpaceConverter
SpaceConverter.categorical()
SpaceConverter.convert_dimension()
SpaceConverter.dimension()
SpaceConverter.fidelity()
SpaceConverter.integer()
SpaceConverter.real()
SpaceConverter.space()
check_random_state()
to_orionspace()
BaseAlgorithm
BaseAlgorithm.configuration
BaseAlgorithm.fidelity_index
BaseAlgorithm.get_id()
BaseAlgorithm.has_completed_max_trials
BaseAlgorithm.has_observed()
BaseAlgorithm.has_suggested()
BaseAlgorithm.has_suggested_all_possible_values()
BaseAlgorithm.is_done
BaseAlgorithm.judge()
BaseAlgorithm.n_observed
BaseAlgorithm.n_suggested
BaseAlgorithm.observe()
BaseAlgorithm.register()
BaseAlgorithm.score()
BaseAlgorithm.seed_rng()
BaseAlgorithm.set_state()
BaseAlgorithm.should_suspend()
BaseAlgorithm.space
BaseAlgorithm.state_dict
BaseAlgorithm.suggest()
BaseAlgorithm.unwrapped
Random
Random.seed_rng()
Random.set_state()
Random.state_dict
Random.suggest()
GridSearch
GridSearch.build_grid()
GridSearch.configuration
GridSearch.is_done
GridSearch.set_state()
GridSearch.state_dict
GridSearch.suggest()
categorical_grid()
discrete_grid()
grid()
real_grid()
BudgetTuple
BudgetTuple.n_trials
BudgetTuple.resource_budget
Hyperband
Hyperband.executed_times
Hyperband.fidelity_index
Hyperband.is_done
Hyperband.observe()
Hyperband.sample_from_bracket()
Hyperband.seed_rng()
Hyperband.set_state()
Hyperband.state_dict
Hyperband.suggest()
HyperbandBracket
HyperbandBracket.get_candidates()
HyperbandBracket.get_trial_max_resource()
HyperbandBracket.has_rung_filled()
HyperbandBracket.is_done
HyperbandBracket.is_filled
HyperbandBracket.is_ready()
HyperbandBracket.promote()
HyperbandBracket.register()
HyperbandBracket.seed_rng()
RungDict
compute_budgets()
display_budgets()
ASHA
ASHA.suggest()
ASHABracket
ASHABracket.get_candidates()
ASHABracket.is_filled
ASHABracket.is_ready()
ASHABracket.promote()
DEHB
DEHB.is_done
DEHB.observe()
DEHB.observe_one()
DEHB.sample_to_trial()
DEHB.seed_rng()
DEHB.set_state()
DEHB.state_dict
DEHB.suggest()
SHBracketManager
SHBracketManager.complete_job()
SHBracketManagerImpl
BOHB
BOHB.is_done
BOHB.observe()
BOHB.seed_rng()
BOHB.set_state()
BOHB.state_dict
BOHB.suggest()
PBT
LineageNode
Lineages
PB2
TVSquaredExp
UCB()
normalize()
optimize_acq()
select_config()
select_length()
standardize()
CategoricalSampler
CategoricalSampler.get_loglikelis()
CategoricalSampler.sample()
GMMSampler
GMMSampler.get_loglikelis()
GMMSampler.sample()
TPE
TPE.seed_rng()
TPE.set_state()
TPE.split_trials()
TPE.state_dict
TPE.suggest()
adaptive_parzen_estimator()
compute_max_ei_point()
ramp_up_weights()
AxOptimizer
AxOptimizer.get_client()
AxOptimizer.observe()
AxOptimizer.reverse_params()
AxOptimizer.seed_rng()
AxOptimizer.set_state()
AxOptimizer.state_dict
AxOptimizer.suggest()
AxOptimizer.transform_params()
orion.algo.mofa.mofa
MOFA
MOFA.is_done
MOFA.observe()
MOFA.seed_rng()
MOFA.set_state()
MOFA.state_dict
MOFA.suggest()
get_factorial_importance_analysis()
get_factorial_performance_analysis()
select_new_region_of_interest()
NevergradOptimizer
NevergradOptimizer.is_done
NevergradOptimizer.observe()
NevergradOptimizer.seed_rng()
NevergradOptimizer.set_state()
NevergradOptimizer.state_dict
NevergradOptimizer.suggest()
HEBO
HEBO.Parameters
HEBO.observe()
HEBO.seed_rng()
HEBO.set_state()
HEBO.state_dict
HEBO.suggest()
average()
flatten_numpy()
flatten_params()
ranking()
to_numpy()
train_regressor()
lpi()
partial_dependency()
regret()
Benchmark
Benchmark.analysis()
Benchmark.configuration
Benchmark.executor
Benchmark.get_experiments()
Benchmark.id
Benchmark.process()
Benchmark.setup_studies()
Benchmark.status()
Study
Study.analysis()
Study.execute()
Study.get_experiments()
Study.setup_experiments()
Study.status()
get_or_create_benchmark()
BenchmarkTask
BenchmarkTask.__call__()
BenchmarkTask.call()
BenchmarkTask.configuration
BenchmarkTask.get_search_space()
BenchmarkTask.max_trials
Branin
Branin.call()
Branin.get_search_space()
CarromTable
CarromTable.call()
CarromTable.get_search_space()
EggHolder
EggHolder.call()
EggHolder.get_search_space()
Forrester
Forrester.call()
Forrester.get_search_space()
RosenBrock
RosenBrock.call()
RosenBrock.get_search_space()
ProfetFcNetTask
ProfetForresterTask
ProfetSvmTask
ProfetTask
ProfetXgBoostTask
AverageRank
AverageRank.analysis()
AverageResult
AverageResult.analysis()
BenchmarkAssessment
BenchmarkAssessment.analysis()
BenchmarkAssessment.configuration
BenchmarkAssessment.get_executor()
BenchmarkAssessment.repetitions
ParallelAssessment
ParallelAssessment.analysis()
ParallelAssessment.configuration
ParallelAssessment.get_executor()
interrupt_trial()
report_bad_trial()
report_objective()
report_results()
ExperimentClient
ExperimentClient.algorithm
ExperimentClient.close()
ExperimentClient.configuration
ExperimentClient.executor
ExperimentClient.fetch_noncompleted_trials()
ExperimentClient.fetch_pending_trials()
ExperimentClient.fetch_trials()
ExperimentClient.fetch_trials_by_status()
ExperimentClient.get_trial()
ExperimentClient.id
ExperimentClient.insert()
ExperimentClient.is_broken
ExperimentClient.is_done
ExperimentClient.max_broken
ExperimentClient.max_trials
ExperimentClient.metadata
ExperimentClient.mode
ExperimentClient.name
ExperimentClient.node
ExperimentClient.observe()
ExperimentClient.producer
ExperimentClient.refers
ExperimentClient.release()
ExperimentClient.reserve()
ExperimentClient.space
ExperimentClient.stats
ExperimentClient.storage
ExperimentClient.suggest()
ExperimentClient.tmp_executor()
ExperimentClient.to_pandas()
ExperimentClient.version
ExperimentClient.working_dir
ExperimentClient.workon()
reserve_trial()
insert_trials()
build_experiment()
create_experiment()
get_experiment()
workon()
build_config()
define_config()
define_database_config()
define_evc_config()
define_experiment_config()
define_frontends_uri_config()
define_storage_config()
define_worker_config()
Consumer
ExecutionError
Experiment
ExperimentStats
create_algo()
Producer
Compose
Enumerate
Identity
Linearize
OneHotEncode
Precision
Quantize
ReshapedDimension
ReshapedSpace
Reverse
TransformedDimension
TransformedSpace
Transformer
View
build_required_space()
build_transform()
change_trial_params()
reshape()
transform()
Trial
AlreadyReleased
validate_status()
TrialPacemaker
ExperimentNode
adapt_trials()
AlgorithmChange
BaseAdapter
CodeChange
CommandLineChange
CompositeAdapter
DimensionAddition
DimensionDeletion
DimensionPriorChange
DimensionRenaming
OrionVersionChange
ScriptConfigChange
apply_if_valid()
AlgorithmConflict
ChangedDimensionConflict
CodeConflict
CommandLineConflict
Conflict
Conflicts
ExperimentNameConflict
MissingDimensionConflict
NewDimensionConflict
OrionVersionConflict
Resolution
ScriptConfigConflict
detect_conflicts()
Database
DatabaseError
DatabaseTimeout
DuplicateKeyError
OutdatedDatabaseError
ReadOnlyDB
BaseConverter
GenericConverter
JSONConverter
YAMLConverter
infer_converter_from_file_type()
DimensionBuilder
SpaceBuilder
replace_key_in_order()
fetch_config()
fetch_config_from_cmdargs()
fetch_env_vars()
fetch_metadata()
fetch_user_repo()
infer_versioning_metadata()
is_exe()
merge_configs()
update_metadata()
ExperimentBuilder
build()
build_from_args()
clean_config()
get_cmd_config()
get_from_args()
load()
merge_algorithm_config()
merge_producer_config()
ExperimentBranchBuilder
load_modules_parser()
main()
OrionArgsParser
get_basic_args_group()
get_user_args_group()
add_subparser()
on_error()
fetch_branching_configuration()
get_branching_args_group()
BranchingEvent
BrokenExperiment
CheckError
CompletedExperiment
InexecutableUserScript
InvalidResult
LazyWorkers
MissingResultFile
NoConfigurationError
NoNameError
RaceCondition
ReservationRaceCondition
ReservationTimeout
UnsupportedOperation
WaitingForTrials
dict_to_trial()
get_trial_results()
standard_param_name()
trial_to_tuple()
tuple_to_trial()
format_algorithm()
format_commandline()
format_config()
format_dict()
format_identification()
format_info()
format_list()
format_metadata()
format_refers()
format_space()
format_stats()
format_title()
get_trial_params()
AbstractSingletonType
GenericSingletonFactory
SingletonAlreadyInstantiatedError
SingletonFactory
SingletonNotInstantiatedError
SingletonType
DepthFirstTraversal()
PreOrderTraversal()
TreeNode
flattened()
Factory
Factory.__call__()
GenericFactory
GenericFactory.create()
GenericFactory.get_class()
GenericFactory.get_classes()
compute_identity()
float_to_digits_list()
get_all_subclasses()
get_all_types()
nesteddict()
sigterm_as_interrupt()
AsyncException
AsyncException.value
AsyncResult
BaseExecutor
BaseExecutor.async_get()
BaseExecutor.submit()
BaseExecutor.wait()
ExecutorClosed
Future
Future.get()
Future.ready()
Future.successful()
Future.wait()
Dask
Dask.async_get()
Dask.submit()
Dask.wait()
Pool
PoolExecutor
PoolExecutor.async_get()
PoolExecutor.submit()
PoolExecutor.wait()
ThreadPool
SingleExecutor
SingleExecutor.async_get()
SingleExecutor.close()
SingleExecutor.submit()
SingleExecutor.wait()
Joblib
PlotAccessor
PlotAccessor.__call__()
PlotAccessor.lpi()
PlotAccessor.parallel_coordinates()
PlotAccessor.partial_dependencies()
PlotAccessor.regret()
durations()
parallel_assessment()
parallel_coordinates()
partial_dependencies()
rankings()
regrets()
build_durations_frame()
build_parallel_frame()
build_regrets_frame()
BaseStorageProtocol
BaseStorageProtocol.acquire_algorithm_lock()
BaseStorageProtocol.count_broken_trials()
BaseStorageProtocol.count_completed_trials()
BaseStorageProtocol.create_benchmark()
BaseStorageProtocol.create_experiment()
BaseStorageProtocol.delete_algorithm_lock()
BaseStorageProtocol.delete_experiment()
BaseStorageProtocol.delete_trials()
BaseStorageProtocol.fetch_benchmark()
BaseStorageProtocol.fetch_experiments()
BaseStorageProtocol.fetch_lost_trials()
BaseStorageProtocol.fetch_noncompleted_trials()
BaseStorageProtocol.fetch_pending_trials()
BaseStorageProtocol.fetch_trials()
BaseStorageProtocol.fetch_trials_by_status()
BaseStorageProtocol.get_algorithm_lock_info()
BaseStorageProtocol.get_trial()
BaseStorageProtocol.initialize_algorithm_lock()
BaseStorageProtocol.push_trial_results()
BaseStorageProtocol.register_trial()
BaseStorageProtocol.release_algorithm_lock()
BaseStorageProtocol.reserve_trial()
BaseStorageProtocol.retrieve_result()
BaseStorageProtocol.set_trial_status()
BaseStorageProtocol.update_experiment()
BaseStorageProtocol.update_heartbeat()
BaseStorageProtocol.update_trial()
BaseStorageProtocol.update_trials()
FailedUpdate
LockAcquisitionTimeout
LockedAlgorithmState
LockedAlgorithmState.reset()
LockedAlgorithmState.set_state()
LockedAlgorithmState.state
MissingArguments
ReadOnlyStorageProtocol
get_trial_uid_and_exp()
get_uid()
setup_storage()
Legacy
Legacy.acquire_algorithm_lock()
Legacy.count_broken_trials()
Legacy.count_completed_trials()
Legacy.create_benchmark()
Legacy.create_experiment()
Legacy.delete_algorithm_lock()
Legacy.delete_experiment()
Legacy.delete_trials()
Legacy.fetch_benchmark()
Legacy.fetch_experiments()
Legacy.fetch_lost_trials()
Legacy.fetch_noncompleted_trials()
Legacy.fetch_pending_trials()
Legacy.fetch_trials()
Legacy.fetch_trials_by_status()
Legacy.get_algorithm_lock_info()
Legacy.get_trial()
Legacy.initialize_algorithm_lock()
Legacy.push_trial_results()
Legacy.register_trial()
Legacy.release_algorithm_lock()
Legacy.reserve_trial()
Legacy.retrieve_result()
Legacy.set_trial_status()
Legacy.update_experiment()
Legacy.update_heartbeat()
Legacy.update_trial()
Legacy.update_trials()
setup_database()
Track
Track.acquire_algorithm_lock()
Track.count_broken_trials()
Track.count_completed_trials()
Track.create_experiment()
Track.fetch_experiments()
Track.fetch_lost_trials()
Track.fetch_noncompleted_trials()
Track.fetch_pending_trials()
Track.fetch_trials()
Track.fetch_trials_by_status()
Track.get_trial()
Track.push_trial_results()
Track.register_trial()
Track.reserve_trial()
Track.retrieve_result()
Track.set_trial_status()
Track.update_experiment()
Track.update_heartbeat()
Track.update_trial()
Track.update_trials()
TrialAdapter
TrialAdapter.end_time
TrialAdapter.experiment
TrialAdapter.gradient
TrialAdapter.hash_params
TrialAdapter.heartbeat
TrialAdapter.id
TrialAdapter.objective
TrialAdapter.params
TrialAdapter.parents
TrialAdapter.results
TrialAdapter.status
TrialAdapter.submit_time
TrialAdapter.to_dict()
add_leading_slash()
convert_track_status()
experiment_uid()
get_track_status()
remove_leading_slash()
to_epoch()
BaseAlgoTests
BaseAlgoTests.algo_type
BaseAlgoTests.assert_dim_type_supported()
BaseAlgoTests.create_algo()
BaseAlgoTests.create_space()
BaseAlgoTests.force_observe()
BaseAlgoTests.get_num()
BaseAlgoTests.observe_trials()
BaseAlgoTests.phases
BaseAlgoTests.set_phases()
BaseAlgoTests.test_broken_trials()
BaseAlgoTests.test_cat_data()
BaseAlgoTests.test_configuration()
BaseAlgoTests.test_get_id()
BaseAlgoTests.test_has_observed()
BaseAlgoTests.test_has_observed_statedict()
BaseAlgoTests.test_has_suggested()
BaseAlgoTests.test_has_suggested_statedict()
BaseAlgoTests.test_int_data()
BaseAlgoTests.test_is_done_cardinality()
BaseAlgoTests.test_is_done_max_trials()
BaseAlgoTests.test_logint_data()
BaseAlgoTests.test_logreal_data()
BaseAlgoTests.test_n_observed()
BaseAlgoTests.test_n_suggested()
BaseAlgoTests.test_observe()
BaseAlgoTests.test_optimize_branin()
BaseAlgoTests.test_real_data()
BaseAlgoTests.test_seed_rng()
BaseAlgoTests.test_seed_rng_init()
BaseAlgoTests.test_shape_data()
BaseAlgoTests.test_state_dict()
BaseAlgoTests.test_suggest_n()
BaseAlgoTests.update_space()
BaseParallelStrategyTests
BaseParallelStrategyTests.create_strategy()
BaseParallelStrategyTests.get_corrupted_trial()
BaseParallelStrategyTests.get_noncompleted_trial()
BaseParallelStrategyTests.get_trials()
BaseParallelStrategyTests.test_configuration()
BaseParallelStrategyTests.test_handle_corrupted_trials()
BaseParallelStrategyTests.test_infer_no_history()
BaseParallelStrategyTests.test_state_dict()
BaseParallelStrategyTests.test_strategy_value()
TestPhase
TestPhase.end_n_trials
TestPhase.length
TestPhase.method_to_spy
TestPhase.n_trials
TestPhase.name
customized_mutate_example()
first_phase_only()
last_phase_only()
assert_durations_plot()
assert_lpi_plot()
assert_parallel_coordinates_plot()
assert_partial_dependencies_plot()
assert_rankings_plot()
assert_regret_plot()
assert_regrets_plot()
build_space()
dim1()
dim2()
dim3()
dim4()
BaseOrionState
BaseOrionState.add_experiments()
BaseOrionState.add_trials()
BaseOrionState.cleanup()
BaseOrionState.get_experiment()
BaseOrionState.get_trial()
BaseOrionState.init()
BaseOrionState.load_experience_configuration()
BaseOrionState.make_config()
BaseOrionState.setup_storage()
LegacyOrionState
LegacyOrionState.cleanup()
LegacyOrionState.database
LegacyOrionState.get_experiment()
LegacyOrionState.init()
OrionState()
MockDatetime
MockDatetime.utcnow()
default_datetime()
falcon_client()
generate_benchmark_experiments_trials()
generate_trials()
mock_space_iterate()
mocked_datetime()
Developer Guide