SAMPO Reference
===============

Input Specification
-------------------

* Data Specification
   .. toctree::
      :maxdepth: 1
      :glob:

      input/csv.rst
      input/pandas_df.rst
      input/arff.rst

.. toctree::
   :maxdepth: 1
   :glob:

   input/spd.rst
   input/src.rst
   input/ssc.rst
   input/asd.rst

API Specification
-----------------
* sampo.api
   .. toctree::
      :maxdepth: 2
      :glob:

      sampo/api/*

* sampotools.api
   .. toctree::
      :maxdepth: 1
      :glob:

      sampotools/api/*

* sampovis.api
   .. toctree::
      :maxdepth: 2
      :glob:

      sampovis/api/*

Limitations
~~~~~~~~~~~

* Parallel execution of SAMPO API support only the following API:
    * sampo.api.process_store.list_process_metadata
    * sampo.api.process_store.list_comp_metadata

Component Specification
-----------------------
* Data Loader
    .. toctree::
       :maxdepth: 1
       :glob:

       sampo/components/dataloader/*

* Feature Descriptor/Learner
   .. toctree::
      :maxdepth: 1
      :glob:

      sampo/components/feature_generator/*

* Regression/Classification
    .. toctree::
       :maxdepth: 1
       :glob:

       sampo/components/predictor/*

Command Specification
---------------------
* Analytics Process Commands
    .. toctree::
       :maxdepth: 1
       :glob:

       sampo/command/analytics_process/*

* ProcessStore Commands
    .. toctree::
       :maxdepth: 1
       :glob:

       sampo/command/process_store/*

* ProcessStore Commands for FAB/HME Components
    .. toctree::
       :maxdepth: 1
       :glob:

       sampo/command/process_store_fabhme/*

* Visualization Commands
    .. toctree::
       :maxdepth: 1
       :glob:

       sampovis/command/*

* Utility Commands
    .. toctree::
       :maxdepth: 1
       :glob:

       sampotools/command/csv2asd.rst
       sampotools/command/db2asd.rst
       sampotools/command/db2csv.rst
       sampotools/command/csv2arffheader.rst

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

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