.. eddl documentation master file, created by
   sphinx-quickstart on Tue Jan 28 11:13:03 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to EDDL's documentation!
================================

EDDL is an optimized tensor library for distributed deep learning with hardware transparency support for CPUs, GPUs and FPGAs
The code is open source, and `available on github`_.


.. toctree::
    :maxdepth: 1
    :caption: Installation

    intro/installation.rst
    intro/build-options.rst
    intro/troubleshoot.rst
    intro/faq.rst


.. toctree::
    :maxdepth: 1
    :caption: Get started

    usage/getting_started.rst
    usage/intermediate.rst
    usage/advanced.rst
    usage/pretrained.rst


.. toctree::
    :maxdepth: 1
    :caption: Videotutorials

    videotutorials/developers.rst
    videotutorials/usage.rst


.. toctree::
    :maxdepth: 1
    :caption: Layers

    layers/core.rst
    layers/auxiliar.rst
    layers/activations.rst
    layers/data_augmentation.rst
    layers/data_transformation.rst
    layers/convolutional.rst
    layers/noise.rst
    layers/pooling.rst
    layers/normalization.rst
    layers/merge.rst
    layers/generators.rst
    layers/operators.rst
    layers/reduction.rst
    layers/rnn.rst


.. toctree::
    :maxdepth: 1
    :caption: Model

    model/model.rst
    model/onnx.rst


.. toctree::
    :maxdepth: 1
    :caption: Training

    training/coarse.rst
    training/fine_grained.rst


.. toctree::
    :maxdepth: 1
    :caption: Test & Score

    test_score/test_score.rst


.. toctree::
    :maxdepth: 1
    :caption: Bundle

    bundle/losses.rst
    bundle/metrics.rst
    bundle/regularizers.rst
    bundle/initializers.rst
    bundle/optimizers.rst


.. toctree::
    :maxdepth: 1
    :caption: Computing Services

    bundle/computing_service.rst


.. toctree::
    :maxdepth: 1
    :caption: Model Zoo

    models_zoo/classification.rst


.. toctree::
    :maxdepth: 1
    :caption: Datasets

    datasets/classification.rst
    datasets/segmentation.rst


.. toctree::
    :maxdepth: 1
    :caption: Tensor

    tensor/create.rst
    tensor/manipulation.rst
    tensor/image.rst
    tensor/indexing.rst
    tensor/input_output.rst
    tensor/linear_algebra.rst
    tensor/logic_functions.rst
    tensor/math.rst
    tensor/misc.rst


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

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


.. _available on github: https://github.com/deephealthproject/eddl