.. _f-dlbase:

module ``ai.dlbase``
====================





.. inheritance-diagram:: code_beatrix.ai.dlbase


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

module ``code_beatrix.ai.dlbase``

Base class for deep learning models.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| class                                                                 | truncated documentation                                                                         |
+=======================================================================+=================================================================================================+
| :class:`DeepLearningBase <code_beatrix.ai.dlbase.DeepLearningBase>`   | Implements a common interface to manipulate pre-trained deep learning models.                   |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :class:`DeepLearningImage <code_beatrix.ai.dlbase.DeepLearningImage>` | Implements a common interface to manipulate pre-trained deep learning models processing images. |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+










Methods
+++++++

+-------------------------------------------------------------------------+------------------------------------+
| method                                                                  | truncated documentation            |
+=========================================================================+====================================+
| :py:meth:`__init__ <code_beatrix.ai.dlbase.DeepLearningBase.__init__>`  |                                    |
+-------------------------------------------------------------------------+------------------------------------+
| :py:meth:`__init__ <code_beatrix.ai.dlbase.DeepLearningImage.__init__>` |                                    |
+-------------------------------------------------------------------------+------------------------------------+
| :meth:`log <code_beatrix.ai.dlbase.DeepLearningBase.log>`               | Log something.                     |
+-------------------------------------------------------------------------+------------------------------------+
| :meth:`log <code_beatrix.ai.dlbase.DeepLearningImage.log>`              | Log something.                     |
+-------------------------------------------------------------------------+------------------------------------+
| :meth:`predict <code_beatrix.ai.dlbase.DeepLearningBase.predict>`       | Applies the model on features *X*. |
+-------------------------------------------------------------------------+------------------------------------+
| :meth:`predict <code_beatrix.ai.dlbase.DeepLearningImage.predict>`      | Applies the model on features *X*. |
+-------------------------------------------------------------------------+------------------------------------+


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

.. automodule:: code_beatrix.ai.dlbase
    :members:
    :special-members: __init__
    :show-inheritance: