.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                       | class parent | truncated documentation                                                                                                           |
+================================================================================================================================+==============+===================================================================================================================================+
| :func:`_setup_hook <pymlbenchmark._setup_hook>`                                                                                |              | If this function is added to the module, the help automation and unit tests call it first before anything goes on ...             |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`ax_position <pymlbenchmark.plotting.plot_helper.ax_position>`                                                           |              | :epkg:`matplotlib` uses a one dimension array if the number of columns or rows is 1. This function makes a correction. ...        |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`bench_pivot <pymlbenchmark.benchmark.bench_helper.bench_pivot>`                                                         |              | Merges all results for one set of parameters in one row.                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <pymlbenchmark.check>`                                                                                            |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                           |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_options <pymlbenchmark.benchmark.bench_helper.enumerate_options>`                                             |              | Enumerates all possible options.                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`experiment_results <pymlbenchmark.datasets.real_data.experiment_results>`                                               |              | Returns some real results mostly used in the documentation to produce graph to illustrate a function.                             |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`filter_df_options <pymlbenchmark.plotting.plot_helper.filter_df_options>`                                               |              | Filters out rows from a dataframe.                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_nb_skl_base_estimators <pymlbenchmark.benchmark.sklearn_helper.get_nb_skl_base_estimators>`                         |              | Returns the number of :epkg:`scikit-learn` *BaseEstimator* including in a pipeline. The function assumes the pipeline ...         |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_numpy_info <pymlbenchmark.context.machine.get_numpy_info>`                                                          |              | Retrieves information about numpy compilation.                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`list_col_options <pymlbenchmark.plotting.plot_helper.list_col_options>`                                                 |              |                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`machine_information <pymlbenchmark.context.machine.machine_information>`                                                |              | Returns information about the machine.                                                                                            |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`move_color <pymlbenchmark.plotting.plot_helper.move_color>`                                                             |              | Returns a different colors, lighter or darker.                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`move_color_add <pymlbenchmark.plotting.plot_helper.move_color_add>`                                                     |              | Makes color lighter or darker based on a style.                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`onnxruntime_perf_binary_classifiers <pymlbenchmark.external.onnxruntime_perf_list.onnxruntime_perf_binary_classifiers>` |              | Returns a list of benchmarks for binary classifier. It compares :epkg:`onnxruntime` predictions against :epkg:`scikit-learn`. ... |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`onnxruntime_perf_regressors <pymlbenchmark.external.onnxruntime_perf_list.onnxruntime_perf_regressors>`                 |              | Returns a list of benchmarks for binary classifier. It compares :epkg:`onnxruntime` predictions against :epkg:`scikit-learn`. ... |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`options2label <pymlbenchmark.plotting.plot_helper.options2label>`                                                       |              | Converts a list of options into a label.                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_bench_results <pymlbenchmark.plotting.plot_bench_results.plot_bench_results>`                                      |              | Plots benchmark results.                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_bench_xtime <pymlbenchmark.plotting.plot_bench_xtime.plot_bench_xtime>`                                            |              | Plots benchmark acceleration.                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`plt_colors <pymlbenchmark.plotting.plot_helper.plt_colors>`                                                             |              | Returns :epkg:`matplotlib` colors.                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`plt_styles <pymlbenchmark.plotting.plot_helper.plt_styles>`                                                             |              | Returns :epkg:`matplotlib` styles.                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`random_binary_classification <pymlbenchmark.datasets.artificial.random_binary_classification>`                          |              | Returns data for a binary classification problem (linear) with *N* observations and *dim* features.                               |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`random_regression <pymlbenchmark.datasets.artificial.random_regression>`                                                |              | Returns data for a binary classification problem (linear) with *N* observations and *dim* features.                               |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`remove_almost_nan_columns <pymlbenchmark.benchmark.bench_helper.remove_almost_nan_columns>`                             |              | Automatically removes columns with more than 1/3 nan values.                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`remove_common_prefix <pymlbenchmark.plotting.plot_helper.remove_common_prefix>`                                         |              | Removes the common prefix of a series of labels.                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :func:`run_onnxruntime_test <pymlbenchmark.external.onnxruntime_perf_list.run_onnxruntime_test>`                               |              | Runs a benchmark for :epkg:`onnxruntime`.                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------+