rlearn.reporting.report_model_search_results

rlearn.reporting.report_model_search_results(model_search_cv, sort_results=None)[source]

Generate a model search report of results.

Parameters:
model_search_cv : object of ModelSearchCV class

The fitted ModelSearchCV object.

sort_results : str or None

The parameter to use to sort the results.

Returns:
report : object of pd.DataFrame class

A report as a pandas DataFrame.