.. _f-createasvhelper:

module ``asv_benchmark._create_asv_helper``
===========================================







Short summary
+++++++++++++

module ``mlprodict.asv_benchmark._create_asv_helper``

Functions to creates a benchmark based on :epkg:`asv`
for many regressors and classifiers.


:githublink:`%|py|5`






Functions
+++++++++

+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| function                                                                                                       | truncated documentation                                                                                     |
+================================================================================================================+=============================================================================================================+
| :func:`_additional_imports <mlprodict.asv_benchmark._create_asv_helper._additional_imports>`                   | Adds additional imports for experimental models.                                                            |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_asv_class_name <mlprodict.asv_benchmark._create_asv_helper._asv_class_name>`                           |                                                                                                             |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_display_code_lines <mlprodict.asv_benchmark._create_asv_helper._display_code_lines>`                   |                                                                                                             |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_format_dict <mlprodict.asv_benchmark._create_asv_helper._format_dict>`                                 | Formats a dictionary as code.                                                                               |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_handle_init_files <mlprodict.asv_benchmark._create_asv_helper._handle_init_files>`                     | Returns created, location_model, prefix_import.                                                             |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_read_patterns <mlprodict.asv_benchmark._create_asv_helper._read_patterns>`                             | Reads the testing pattern.                                                                                  |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_select_pattern_problem <mlprodict.asv_benchmark._create_asv_helper._select_pattern_problem>`           | Selects a benchmark type based on the problem kind.                                                         |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`_sklearn_subfolder <mlprodict.asv_benchmark._create_asv_helper._sklearn_subfolder>`                     | Returns the list of subfolders for a model.                                                                 |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`add_model_import_init <mlprodict.asv_benchmark._create_asv_helper.add_model_import_init>`               | Modifies a template such as :class:`TemplateBenchmarkClassifier` with code associated to the model *model*. |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`find_missing_sklearn_imports <mlprodict.asv_benchmark._create_asv_helper.find_missing_sklearn_imports>` | Finds in :epkg:`scikit-learn` the missing pieces.                                                           |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :func:`find_sklearn_module <mlprodict.asv_benchmark._create_asv_helper.find_sklearn_module>`                   | Finds the corresponding modulee for an element of :epkg:`scikit-learn`.                                     |
+----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: mlprodict.asv_benchmark._create_asv_helper
    :members:
    :special-members: __init__
    :show-inheritance: