Metadata-Version: 2.1
Name: hottbox
Version: 0.1.2
Summary: Higher Order Tensors ToolBOX
Home-page: https://github.com/hottbox/hottbox
Author: Ilya Kisil
Author-email: ilyakisil@gmail.com
License: Apache License 2.0
Keywords: tensor decompositions,machine learning
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Dist: numpy
Requires-Dist: scipy

|Travis|_ |Appveyor|_ |Coveralls|_

.. |Travis| image:: https://img.shields.io/travis/hottbox/hottbox/master.svg?label=TravisCI
.. _Travis: https://travis-ci.org/hottbox/hottbox/

.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/sh2rk41gpn26h7a7/branch/master?svg=true
.. _Appveyor: https://ci.appveyor.com/project/IlyaKisil/hottbox-6jq6a

.. |Coveralls| image:: https://img.shields.io/coveralls/github/hottbox/hottbox/master.svg
.. _Coveralls: https://coveralls.io/github/hottbox/hottbox

Higher Order Tensors ToolBOX (hottbox)
======================================

Welcome to the toolbox for tensor decompositions, statistical analysis, visualisation, feature extraction, 
regression and non-linear classification of multi-dimensional data. 


Installing HOTTBOX
------------------

There are two options available:

1.  Install ``hottbox`` as it is from `pypi.org <https://pypi.org/project/hottbox/>`_
    by executing: ::

        $ pip install hottbox

2.  Alternatively, you can clone the source code which you can find on our `GitHub repository <https://github.com/hottbox/hottbox>`_
    and install ``hottbox`` in editable mode:
    ::

        $ git clone https://github.com/hottbox/hottbox.git

        $ cd hottbox

        $ pip install -e .

    This will allow you to modify the source code in the way it will suit your needs. Additionally, you will be
    on top of the latest changes and will be able to start using new stable features which are located on
    `develop <https://github.com/hottbox/hottbox/tree/develop>`_ branch until the official release.



Running tests
-------------

If you have chosen the second installation option, it is advisable to run tests in order to make sure that your
current version of ``hottbox`` is stable. First, you will need to install ``pytest`` and ``pytest-cov`` packages: ::

    $ pip install pytest pytest-cov

To run test, simply execute inside the main directory: ::

    $ pytest -v --cov hottbox



HOTTBOX tutorials
-----------------

Please check out `our repository <https://github.com/hottbox/hottbox-tutorials>`_ with tutorials on ``hottbox`` api
and theoretical background on multi-linear algebra and tensor decompositions.


Development
-----------
We welcome new contributors of all experience levels. Detailed guidelines can be found on
`our web site <https://hottbox.github.io/stable/development_guide/index.html>`_.


