.. _f-sklmodelclustering:

module ``asv_benchmark.template.skl_model_clustering``
======================================================





.. inheritance-diagram:: mlprodict.asv_benchmark.template.skl_model_clustering


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

module ``mlprodict.asv_benchmark.template.skl_model_clustering``

A template to benchmark a model
with :epkg:`asv`. The benchmark can be run through
file :epkg:`run_asv.sh` on Linux or :epkg:`run_asv.bat` on
Windows.





Classes
+++++++

+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                    | truncated documentation                                                                                                                                                                                |
+==========================================================================================================================+========================================================================================================================================================================================================+
| :class:`TemplateBenchmarkClustering <mlprodict.asv_benchmark.template.skl_model_clustering.TemplateBenchmarkClustering>` | :epkg:`asv` example for a clustering algorithm, Full template can be found in `common_asv_skl.py <https://github.com/sdpython/mlprodict/ blob/master/mlprodict/asv_benchmark/common_asv_skl.py>`_. ... |
+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                                                     | truncated documentation |
+============================================================================================================================+=========================+
| :py:meth:`_create_model <mlprodict.asv_benchmark.template.skl_model_clustering.TemplateBenchmarkClustering._create_model>` |                         |
+----------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`setup_cache <mlprodict.asv_benchmark.template.skl_model_clustering.TemplateBenchmarkClustering.setup_cache>`        |                         |
+----------------------------------------------------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: mlprodict.asv_benchmark.template.skl_model_clustering
    :members:
    :special-members: __init__
    :show-inheritance: