Hyperactive
Hyperactive copied to clipboard
[API] open design and naming questions for v5
Collecting some open design and naming questions for v5.
References:
- reference design PR for skbase objects - https://github.com/SimonBlanke/Hyperactive/pull/110
Folder names
- what should the name of the top-level module for tuners/optimizers be? Format
hyperactive.name. Could be:opt,optimize,optimizer,optimizers,tune,tuners, ... - what should the name of the top-level module for tuning runs be, e.g., single cross-validation run, or individual objective functions?
experiment,experiments,objectives,searches, ...
Method names
- what should the method be called that evaluates a single run of an experiment, e.g., one run of cross-validating an estimator inside a tuner?
score,query,objective,objective_value,objective_function, ... - what should the method be called that finds the optimal solution to an experiment?
run,search,find,optimize,tune, ...
Call patterns
How would you, as a user, want to specify configurations for the experiment to run?
Option 1: all in __init__ of the tuner
Option 2: partly in __init__, partly in a method add_search (with name tbd)
Option 3: both should be possible