.. mlcomm documentation master file, created by
   sphinx-quickstart on Tue Jul 16 22:57:58 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.



.. image:: media/montage_atl2077.png

Welcome to the documentation for mlcomm!
=========================================

The next-generation telecommunications in Beyond 5G, 6G, and Internet of Things (IoT) concepts require reliabilty and low-latency to fuel the increasing requirement for fast and available data.  Leveraging practices in Machine Learning to enhance and modify existing features in the current standards enable these future capabilities.

Check out the :doc:`setup_and_installation` section for further information, including
how to install the project.


.. toctree::
    :maxdepth: 2
    :caption: Getting Started
    
    setup_and_installation
    
.. toctree::
    :maxdepth: 2
    :caption: Functional Blocks
    
    algorithms
    codebooks
    channels
    util

.. toctree::
    :maxdepth: 2
    :caption: Tutorials:
    
    tutorials/simulation_quickstart
    tutorials/building_codebooks
    tutorials/algorithm_prototypes
    tutorials/sphinx_rtd_relatively_painless