Base definition of tasks

Base definition of Task

class orion.benchmark.task.base.BenchmarkTask(max_trials: int, **kwargs)

Base class describing what a task can do. A task will define the objective function and search space of it.

Parameters

max_trialsint

Max number of trials the experiment will run against this task.

kwargsdict

Configurable parameters of the task, a particular task implementation can have its own parameters.

Attributes

configuration

Return the configuration of the task.

max_trials

Return the max number of trials to run for the task.

Methods

__call__(*args, **kwargs)	All tasks will be callable by default, and method call() will be executed when a task is called directly.
call()	Define the black box function to optimize, the function will expect hyper-parameters to search and return objective values of trial with the hyper-parameters.
get_search_space()	Return the search space for the task objective function

__call__(*args, **kwargs)

All tasks will be callable by default, and method call() will be executed when a task is called directly.

abstract call() → List[Dict]

Define the black box function to optimize, the function will expect hyper-parameters to search and return objective values of trial with the hyper-parameters.

This method should be overridden by subclasses. It should receive the hyper-parameters as keyword arguments, with argument names matching the keys of the dictionary returned by get_search_space.

property configuration: Dict[str, Any]

Return the configuration of the task.

abstract get_search_space() → Dict[str, str]

Return the search space for the task objective function

property max_trials: int

Return the max number of trials to run for the task.