.. Zenkai documentation master file, created by
   sphinx-quickstart on Tue Jul  4 09:57:35 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Zenkai - A framework to beyond backpropagation
==============================================
Zenkai is a framework to help researchers to test techniques beyond simple backpropagation for deep learning machines and also define more flexible architectures and training mechanics.

Get Developing With Zenkai
==========================

.. toctree::
   :hidden:
   :caption: Intro:

   intro/overview
   intro/getting_started
   api
   intro/examples
   intro/troubleshooting
   intro/feedback_and_support


:doc:`intro/overview`
    Understand what Zenkai is and how it can help you

:doc:`intro/getting_started`
    Get started using Zenkai

:doc:`api`
    Get acquainted with the API

.. :doc:`intro/examples`
..     Several examples of using Zenkai

.. :doc:`intro/troubleshooting`
..     Solve some common problems

.. :doc:`intro/feedback_and_support`
..     Get in touch to find out more


.. Modules
.. =======

.. .. toctree::
..    :hidden:
..    :caption: Modules:

..    modules/kaku
..    modules/tansaku
..    modules/ensemble
..    modules/targetprop
..    modules/feedback
..    modules/scikit
..    modules/utils


.. :doc:`modules/kaku`
..     Develop a LearningMachine and implement all its components

.. :doc:`modules/tansaku`
..     Implement classes for adding exploration in learning

.. :doc:`modules/ensemble`
..     Modules for implementing ensembles

.. :doc:`modules/targetprop`
..     Modules for implementing target propagation

.. :doc:`modules/feedback`
..     Modules for implementing feedback alignment

.. :doc:`modules/scikit`
..     Modules for adapting scikit learn classes.

.. :doc:`modules/utils`
..     Global utilities in Zenkai

Other
=====

.. toctree::
   :hidden:
   :caption: Contribute:

   other/contribute

:doc:`other/contribute`
    Contribute to Zenkai

.. note::

   This project is under active development.

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

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