reservoirpy.hyper.research#

reservoirpy.hyper.research(objective, dataset, config_path, report_path=None)[source]#

Wrapper for hyperopt fmin function. Will run hyperopt fmin on the objective function passed as argument, on the data stored in the dataset argument.

Note

Installation of hyperopt is required to use this function.

Parameters:

  • objective (Callable) – Objective function defining the function to optimize. Must be able to receive the dataset argument and all parameters sampled by hyperopt during the search. These parameters must be keyword arguments only without default value (this can be achieved by separating them from the other arguments with an empty starred expression. See examples for more info.)

  • dataset (tuple or lists or arrays of data) – Argument used to pass data to the objective function during the hyperopt run. It will be passed as is to the objective function : it can be in whatever format.

  • config_path (str or Path) – Path to the hyperopt experimentation configuration file used to define this run.

  • report_path (str, optional) – Path to the directory where to store the results of the run. By default, this directory is set to be {name of the experiment}/results/.