.. EpyNN documentation master file, created by
   sphinx-quickstart on Tue Jul  6 18:46:11 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::

Data - Model
===============================

Source code in ``EpyNN/epynn/commons/models.py``.

EpyNN binds sample features (X_data) and label (Y_label) to the :py:class:`epynn.commons.models.dataSet` object. Such binding is automatically performed upon instantiation of an `Embedding layer`_ which is required as an input layer when performing training of a Neural Network with EpyNN.

When using the method ``model.predict()`` from the `EpyNN model`_ with samples features (X_data) as argument, the method returns such ``dataSet`` object. Therefore, one may easily call the instance variable attributes summarized below, including both probability and decision predictions for each sample from unlabeled data.

Note that any intermediates can be retrieved at the layer level by following guidelines from `Base layer`_ section.


.. _Embedding layer: Embedding.rst

.. _EpyNN model: EpyNN_Model.rst

.. _Base layer: Layer_Model.rst


DataSet Model
------------------------------


.. autoclass:: epynn.commons.models.dataSet
    :members:

    .. automethod:: __init__


Live examples
------------------------------

* `Practical description of the dataSet object`_.

.. _Practical description of the dataSet object: epynnlive/dummy_boolean/train.html#The-dataSet-object