.. _f-mlstoragerest:

module ``mlapp.mlstorage_rest``
===============================





.. inheritance-diagram:: lightmlrestapi.mlapp.mlstorage_rest


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

module ``lightmlrestapi.mlapp.mlstorage_rest``

Machine Learning Post request


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| class                                                                      | truncated documentation                                                                                                      |
+============================================================================+==============================================================================================================================+
| :class:`MLStoragePost <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost>` | Implements a simple :epkg:`REST API` to upload zip files. The application assumes machine learning models are actionable ... |
+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+








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

+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| staticmethod                                                                    | truncated documentation                                                                    |
+=================================================================================+============================================================================================+
| :meth:`data2json <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost.data2json>` | :epkg:`numpy:array` cannot be converted into :epkg:`json`. We change the type into a list. |
+---------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+




Methods
+++++++

+----------------------------------------------------------------------------------+-----------------------------------+
| method                                                                           | truncated documentation           |
+==================================================================================+===================================+
| :py:meth:`__init__ <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost.__init__>` |                                   |
+----------------------------------------------------------------------------------+-----------------------------------+
| :py:meth:`_predict <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost._predict>` | Stores the model in the storage.  |
+----------------------------------------------------------------------------------+-----------------------------------+
| :py:meth:`_store <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost._store>`     | Stores the model in the storage.  |
+----------------------------------------------------------------------------------+-----------------------------------+
| :meth:`on_post <lightmlrestapi.mlapp.mlstorage_rest.MLStoragePost.on_post>`      | Processes a :epkg:`POST` request. |
+----------------------------------------------------------------------------------+-----------------------------------+


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

.. automodule:: lightmlrestapi.mlapp.mlstorage_rest
    :members:
    :special-members: __init__
    :show-inheritance: