.. _l-functions: Functions ========= .. contents:: :local: :depth: 1 Summary +++++++ +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | function | class parent | truncated documentation | +=======================================================================================+==============+================================================================================================================================+ | :func:`_setup_hook ` | | if this function is added to the module, the help automation and unit tests call it first before anything goes on ... | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`check ` | | Checks the library is working. It raises an exception. If you want to disable the logs: | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`copy_static ` | | Copy static files into *dest/static*. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_template ` | | Get a template name. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`is_vector ` | | Tells if an array is a vector. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`l1_reg_max ` | | Implements a :epkg:`L1` scoring function which does not consider error above threshold *max_val*. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`mse ` | | Computes `mean_squared_error `_. ... | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`multi_label_jaccard ` | | Applies to a multi-label classification problem. Computes the average Jaccard index between two sequences of sets ... | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`read_options ` | | Reads configuration from a file or a dictionary. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`read_users ` | | Reads users definition. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`reshape ` | | Reshape the expected values and predictions. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`roc_auc_score_macro ` | | Computes `roc_auc_score `_ with ... | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`roc_auc_score_micro ` | | Computes `roc_auc_score `_ with ... | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+ | :func:`sklearn_metric ` | | Looks into metrics available in :epkg:`scikit-learn:metrics`. | +---------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------+