.. ml-indie-tools documentation master file, created by
   sphinx-quickstart on Wed Dec 22 20:43:34 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ml-indie-tools's documentation!
==========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. currentmodule:: env_tools

============
MLEnv object
============

.. automodule:: env_tools
   
.. autoclass:: MLEnv
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: tuner

==============
MLTuner object
==============

.. automodule:: tuner

.. autoclass:: MLTuner
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: Gutenberg_Dataset

========================
Gutenberg_Dataset object
========================

.. automodule:: Gutenberg_Dataset

.. autoclass:: Gutenberg_Dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: Calibre_Dataset

========================
Calibre_Dataset object
========================

.. automodule:: Calibre_Dataset

.. autoclass:: Calibre_Dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: Folder_Dataset

========================
Folder_Dataset object
========================

.. automodule:: Folder_Dataset

.. autoclass:: Folder_Dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: Text_Dataset

===================
Text_Dataset object
===================

.. automodule:: Text_Dataset

.. autoclass:: Text_Dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: ALU_Dataset

==================
ALU_Dataset object
==================

.. automodule:: ALU_Dataset

.. autoclass:: ALU_Dataset
   :members:
   :undoc-members:
   :show-inheritance:

.. currentmodule:: pytorch_tr_compr_layers

==========================
FeedForwardWithCompression
==========================

.. automodule:: pytorch_tr_compr_layers

.. autoclass:: FeedForwardWithCompression
   :undoc-members:
   :show-inheritance:

===============================
FeedForwardWithCompressionState
===============================
.. autoclass:: FeedForwardWithCompressionState
   :undoc-members:
   :show-inheritance:

====================
BlockWithCompression
====================
.. autoclass:: BlockWithCompression
   :undoc-members:
   :show-inheritance:

=========================
BlockWithCompressionState
=========================
.. autoclass:: BlockWithCompressionState
   :undoc-members:
   :show-inheritance:

==================================
BlockWithCompressionNoYokeResidual
==================================
.. autoclass:: BlockWithCompressionNoYokeResidual
   :undoc-members:
   :show-inheritance:

=======================================
BlockWithCompressionStateNoYokeResidual
=======================================
.. autoclass:: BlockWithCompressionStateNoYokeResidual
   :undoc-members:
   :show-inheritance:

=====================================
MultiHeadSelfAttentionWithCompression
=====================================
.. autoclass:: MultiHeadSelfAttentionWithCompression
   :undoc-members:
   :show-inheritance:

==========================================
MultiHeadSelfAttentionWithCompressionState
==========================================
.. autoclass:: MultiHeadSelfAttentionWithCompressionState
   :undoc-members:
   :show-inheritance:


.. currentmodule:: README

===========
Readme File
===========

.. mdinclude:: README.md

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   README.md

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`