.. _f-mlstorage: module ``mlapp.mlstorage`` ========================== .. inheritance-diagram:: lightmlrestapi.mlapp.mlstorage Short summary +++++++++++++ module ``lightmlrestapi.mlapp.mlstorage`` Machine Learning Post request :githublink:`%|py|5` Classes +++++++ +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +=========================================================================================+========================================================================================================================+ | :class:`AlreadyExistsException ` | Exception raised when a project already exists. | +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :class:`MLStorage ` | Stores machine learned models into folders. The storages expects to find at least one :epkg:`python` following the ... | +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :class:`ZipStorage ` | Stores and restores zipped files. | +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +=====================================================================================+================================================================================================================+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_name ` | A name is valid if it is a variable name or a filename if *data* is True. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_name ` | A name is valid if it is a variable name or a filename if *data* is True. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_import ` | Imports the main module for one model. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_makedirs ` | Creates a subfolder and add a file ``__init__.py``. The function overwrites it file ``__init__.py`` to let ... | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :py:meth:`_makedirs ` | Creates a subfolder and add a file ``__init__.py``. The function overwrites it file ``__init__.py`` to let ... | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`add ` | Adds a project based on the data. A project which already exists cannot be added. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`add ` | Adds a project based on the data. A project which already exists cannot be added. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`call_predict ` | Calls method *restapi_predict* from a stored script *python*. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`call_version ` | Calls method *restapi_version* from a stored script *python*. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`empty_cache ` | Removes one place in the cache if the cache is full. Sort them by last access. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_names ` | Returns the list of sub folders. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_names ` | Returns the list of sub folders. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`exists ` | Tells if project *name* exists. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`exists ` | Tells if project *name* exists. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get ` | Retrieves a project based on its name. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get ` | Retrieves a project based on its name. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get_full_name ` | Returns the full name of a project. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get_full_name ` | Returns the full name of a project. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get_metadata ` | Restores the data procuded by *verify_data*. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`get_metadata ` | Restores the data procuded by *verify_data*. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`load_model ` | Loads a model into the cache if not loaded and returns it. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`verify_data ` | Performs verifications to ensure the data to store is ok. The storages expects to find at least one script ... | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :meth:`verify_data ` | Performs verifications to ensure the data to store is ok. | +-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: lightmlrestapi.mlapp.mlstorage :members: :special-members: __init__ :show-inheritance: