Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the What you really need to know section for the big picture.

julearn.model_selection.register_searcher

julearn.model_selection.register_searcher(searcher_name, searcher, params_attr, overwrite=None)

Register searcher to julearn.

This function allows you to add a scikit-learn compatible searching algorithm to julearn. After, you can call it as all other searchers in julearn.

Parameters:

  • searcher_name (str) – Name by which the searcher will be referenced by.

  • searcher (object) – The searcher class by which the searcher can be initialized.

  • params_attr (str) – The name of the attribute that holds the hyperparameter space to search.

  • overwrite (bool | None, default: None) – decides whether overwrite should be allowed, by default None. Options are:

Raises:

ValueError – If the specified searcher is already available and overwrite is set to False.