.. _l-modules:

Modules
=======

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


Summary
+++++++

+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                          | truncated documentation                                                                                                                                                                                       |
+=================================================+===============================================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                        | module ``lightmlrestapi``    Module *lightmlrestapi*.  Light REST API for machine learned models.      :githublink:`%|py|7`                                                                                   |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                       | module ``lightmlrestapi.args``    Shortcuts to *args*.      :githublink:`%|py|5`                                                                                                                              |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                      | module ``lightmlrestapi.cli``    Shortcut to *cli*.      :githublink:`%|py|5`                                                                                                                                 |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                     | module ``lightmlrestapi.mlapp``    Shortcuts to *mlapp*.      :githublink:`%|py|5`                                                                                                                            |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                    | module ``lightmlrestapi.netrest``    Shortcuts to *netrest*.      :githublink:`%|py|5`                                                                                                                        |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzz>`                   | module ``lightmlrestapi.testing``    Shortcuts to *testing*.      :githublink:`%|py|5`                                                                                                                        |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzz>`                  | module ``lightmlrestapi.testing.data``    List of testing resources.      :githublink:`%|py|5`                                                                                                                |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzz>`                 | module ``lightmlrestapi.tools``    Shortcuts to *tools*.      :githublink:`%|py|5`                                                                                                                            |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__main__ <f-main>`                        | module ``lightmlrestapi.__main__``    Command line.      :githublink:`%|py|6`                                                                                                                                 |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`args_images <f-argsimages>`               | module ``lightmlrestapi.args.args_images``    Playground with images.      :githublink:`%|py|5`                                                                                                               |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`authfiction <f-authfiction>`              | module ``lightmlrestapi.mlapp.authfiction``    Authentification part.      :githublink:`%|py|5`                                                                                                               |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`base_logging <f-baselogging>`             | module ``lightmlrestapi.mlapp.base_logging``    Machine Learning Post request      :githublink:`%|py|5`                                                                                                       |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dummy_applications <f-dummyapplications>` | module ``lightmlrestapi.testing.dummy_applications``    Machine Learning Post request      :githublink:`%|py|5`                                                                                               |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`encrypt_helper <f-encrypthelper>`         | module ``lightmlrestapi.args.encrypt_helper``    Helper about encryption.      :githublink:`%|py|5`                                                                                                           |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`json_helper <f-jsonhelper>`               | module ``lightmlrestapi.tools.json_helper``    Helpers about :epkg:`json`.      :githublink:`%|py|5`                                                                                                          |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`make_encrypt_pwd <f-makeencryptpwd>`      | module ``lightmlrestapi.cli.make_encrypt_pwd``    Creates and runs an Falcon application.      :githublink:`%|py|5`                                                                                           |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`make_ml_app <f-makemlapp>`                | module ``lightmlrestapi.cli.make_ml_app``    Creates and runs an Falcon application.      :githublink:`%|py|5`                                                                                                |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`make_ml_store <f-makemlstore>`            | module ``lightmlrestapi.cli.make_ml_store``    Creates and runs an Falcon application.      :githublink:`%|py|5`                                                                                              |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`make_ml_upload <f-makemlupload>`          | module ``lightmlrestapi.cli.make_ml_upload``    Creates and runs an Falcon application.      :githublink:`%|py|5`                                                                                             |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mlpost_rest <f-mlpostrest>`               | module ``lightmlrestapi.mlapp.mlpost_rest``    Machine Learning Post request      :githublink:`%|py|5`                                                                                                        |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mlstorage <f-mlstorage>`                  | module ``lightmlrestapi.mlapp.mlstorage``    Machine Learning Post request      :githublink:`%|py|5`                                                                                                          |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mlstorage_rest <f-mlstoragerest>`         | module ``lightmlrestapi.mlapp.mlstorage_rest``    Machine Learning Post request      :githublink:`%|py|5`                                                                                                     |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`rest_helper <f-resthelper>`               | module ``lightmlrestapi.netrest.rest_helper``    Helpers to submit REST API requests.      :githublink:`%|py|5`                                                                                               |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`template_dl_keras <f-templatedlkeras>`    | module ``lightmlrestapi.testing.template_dl_keras``    Template application for a machine learning model  based on :epkg:`keras` available through a REST API.      :githublink:`%|py|6`                      |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`template_dl_light <f-templatedllight>`    | module ``lightmlrestapi.testing.template_dl_light``    Template application for a machine learning model  available through a REST API and using images like  deep learning models.      :githublink:`%|py|7` |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`template_dl_torch <f-templatedltorch>`    | module ``lightmlrestapi.testing.template_dl_torch``    Template application for a machine learning model  based on :epkg:`torch` available through a REST API.      :githublink:`%|py|6`                      |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`template_ml <f-templateml>`               | module ``lightmlrestapi.testing.template_ml``    Template application for a machine learning model  available through a REST API.      :githublink:`%|py|6`                                                   |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`zip_helper <f-ziphelper>`                 | module ``lightmlrestapi.args.zip_helper``    Machine Learning Post request      :githublink:`%|py|5`                                                                                                          |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    lightmlrestapi/__init__
    lightmlrestapi/__main__
    lightmlrestapi/args/__init__
    lightmlrestapi/args/args_images
    lightmlrestapi/args/encrypt_helper
    lightmlrestapi/args/zip_helper
    lightmlrestapi/cli/__init__
    lightmlrestapi/cli/make_encrypt_pwd
    lightmlrestapi/cli/make_ml_app
    lightmlrestapi/cli/make_ml_store
    lightmlrestapi/cli/make_ml_upload
    lightmlrestapi/mlapp/__init__
    lightmlrestapi/mlapp/authfiction
    lightmlrestapi/mlapp/base_logging
    lightmlrestapi/mlapp/mlpost_rest
    lightmlrestapi/mlapp/mlstorage
    lightmlrestapi/mlapp/mlstorage_rest
    lightmlrestapi/netrest/__init__
    lightmlrestapi/netrest/rest_helper
    lightmlrestapi/testing/__init__
    lightmlrestapi/testing/data/__init__
    lightmlrestapi/testing/dummy_applications
    lightmlrestapi/testing/template_dl_keras
    lightmlrestapi/testing/template_dl_light
    lightmlrestapi/testing/template_dl_torch
    lightmlrestapi/testing/template_ml
    lightmlrestapi/tools/__init__
    lightmlrestapi/tools/json_helper