.. _l-modules:

Modules
=======

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


Summary
+++++++

+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                        | truncated documentation                                                                                                                                                     |
+===============================================+=============================================================================================================================================================================+
| :ref:`__init__ <f-init>`                      | module ``lightmlboard``    Module *lightmlboard*.  Custom Machine Learning Leaderbord for a competition.      :githublink:`%|py|7`                                          |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                     | module ``lightmlboard.metrics``    Implements metrics.      :githublink:`%|py|5`                                                                                            |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                    | module ``lightmlboard.static``    Helpers around static files.      :githublink:`%|py|5`                                                                                    |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                   | module ``lightmlboard.templates``    About templates.      :githublink:`%|py|5`                                                                                             |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`appml <f-appml>`                        | module ``lightmlboard.appml``    Defines a Tornado application.  Tutorial `chat <https://github.com/tornadoweb/tornado/tree/stable/demos/chat>`_.      :githublink:`%|py|6` |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`classification <f-classification>`      | module ``lightmlboard.metrics.classification``    Metrics about regressions.      :githublink:`%|py|5`                                                                      |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`competition <f-competition>`            | module ``lightmlboard.competition``    Defines a competition.      :githublink:`%|py|6`                                                                                     |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dbengine <f-dbengine>`                  | module ``lightmlboard.dbengine``    Manages a sqlite3 database.      :githublink:`%|py|5`                                                                                   |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dbmanager <f-dbmanager>`                | module ``lightmlboard.dbmanager``    Manages a sqlite3 database to store the results.      :githublink:`%|py|5`                                                             |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`default_options <f-defaultoptions>`     | module ``lightmlboard.default_options``    Default options for the application.      :githublink:`%|py|6`                                                                   |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`handlersml <f-handlersml>`              | module ``lightmlboard.handlersml``    Defines handlers for a Tornado application.      :githublink:`%|py|5`                                                                 |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`options_helpers <f-optionshelpers>`     | module ``lightmlboard.options_helpers``    Defines helpers used in different places of the module.      :githublink:`%|py|5`                                                |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`regression <f-regression>`              | module ``lightmlboard.metrics.regression``    Metrics about regressions.      :githublink:`%|py|5`                                                                          |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`regression_custom <f-regressioncustom>` | module ``lightmlboard.metrics.regression_custom``    Metrics about regressions.      :githublink:`%|py|5`                                                                   |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    lightmlboard/__init__
    lightmlboard/appml
    lightmlboard/competition
    lightmlboard/dbengine
    lightmlboard/dbmanager
    lightmlboard/default_options
    lightmlboard/handlersml
    lightmlboard/metrics/__init__
    lightmlboard/metrics/classification
    lightmlboard/metrics/regression
    lightmlboard/metrics/regression_custom
    lightmlboard/options_helpers
    lightmlboard/static/__init__
    lightmlboard/templates/__init__