.. _l-classes:

Classes
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                   | class parent | truncated documentation                                                                                                      |
+=========================================================================================+==============+==============================================================================================================================+
| :class:`AlreadyExistsException <lightmlrestapi.mlapp.mlstorage.AlreadyExistsException>` |              | Exception raised when a project already exists.                                                                              |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthMiddleware <lightmlrestapi.mlapp.authfiction.AuthMiddleware>`               |              | Authentification. The name and secret comes from a file. The file must store encrypted password.                             |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`BaseLogging <lightmlrestapi.mlapp.base_logging.BaseLogging>`                    |              | Simplifies logging. Logging is encrypted with module :epkg:`pyjwt` if *secret* is specified.                                 |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`JsonError <lightmlrestapi.tools.json_helper.JsonError>`                         |              | Raised when serialization to json does not work.                                                                             |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`MLStorage <lightmlrestapi.mlapp.mlstorage.MLStorage>`                           |              | Stores machine learned models into folders. The storages expects to find at least one :epkg:`python` following the ...       |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :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 ... |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`MachineLearningPost <lightmlrestapi.mlapp.mlpost_rest.MachineLearningPost>`     |              | Implements a simple :epkg:`REST API` which handles a post request, no authentification is required. The model ingests ...    |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`ZipStorage <lightmlrestapi.mlapp.mlstorage.ZipStorage>`                         |              | Stores and restores zipped files.                                                                                            |
+-----------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+