.. _f-cachemodel:

module ``mlbatch.cache_model``
==============================





.. inheritance-diagram:: mlinsights.mlbatch.cache_model


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

module ``mlinsights.mlbatch.cache_model``

Caches to cache training.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------+-------------------------------------------------------------------------------+
| class                                                     | truncated documentation                                                       |
+===========================================================+===============================================================================+
| :class:`MLCache <mlinsights.mlbatch.cache_model.MLCache>` | Implements a cache to reduce the number of trainings a grid search has to do. |
+-----------------------------------------------------------+-------------------------------------------------------------------------------+








Static Methods
++++++++++++++

+----------------------------------------------------------------------------+-------------------------------------------+
| staticmethod                                                               | truncated documentation                   |
+============================================================================+===========================================+
| :meth:`as_key <mlinsights.mlbatch.cache_model.MLCache.as_key>`             | Converts a list of parameters into a key. |
+----------------------------------------------------------------------------+-------------------------------------------+
| :meth:`create_cache <mlinsights.mlbatch.cache_model.MLCache.create_cache>` | Creates a new cache.                      |
+----------------------------------------------------------------------------+-------------------------------------------+
| :meth:`get_cache <mlinsights.mlbatch.cache_model.MLCache.get_cache>`       | Gets a cache with a given name.           |
+----------------------------------------------------------------------------+-------------------------------------------+
| :meth:`has_cache <mlinsights.mlbatch.cache_model.MLCache.has_cache>`       | Tells if cache *name* is present.         |
+----------------------------------------------------------------------------+-------------------------------------------+
| :meth:`remove_cache <mlinsights.mlbatch.cache_model.MLCache.remove_cache>` | Removes a cache with a given name.        |
+----------------------------------------------------------------------------+-------------------------------------------+




Methods
+++++++

+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| method                                                                | truncated documentation                                                 |
+=======================================================================+=========================================================================+
| :py:meth:`__init__ <mlinsights.mlbatch.cache_model.MLCache.__init__>` |                                                                         |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__len__ <mlinsights.mlbatch.cache_model.MLCache.__len__>`   | Returns the number of cached items.                                     |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`cache <mlinsights.mlbatch.cache_model.MLCache.cache>`          | Caches one object.                                                      |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`count <mlinsights.mlbatch.cache_model.MLCache.count>`          | Retrieves the number of times an elements was retrieved from the cache. |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`get <mlinsights.mlbatch.cache_model.MLCache.get>`              | Retrieves an element from the cache.                                    |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`items <mlinsights.mlbatch.cache_model.MLCache.items>`          | Enumerates all cached items.                                            |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`keys <mlinsights.mlbatch.cache_model.MLCache.keys>`            | Enumerates all cached keys.                                             |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------+


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

.. automodule:: mlinsights.mlbatch.cache_model
    :members:
    :special-members: __init__
    :show-inheritance: