Welcome to the toolbox for tensor decompositions, statistical analysis, visualisation, feature extraction, regression and non-linear classification of multi-dimensional data.
There are two options available:
Install
hottbox
as it is from pypi.org by executing:$ pip install hottbox
Alternatively, you can clone the source code which you can find on our GitHub repository 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 branch until the official release.
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
Please check out our repository with tutorials on hottbox
api
and theoretical background on multi-linear algebra and tensor decompositions.
We welcome new contributors of all experience levels. Detailed guidelines can be found on our web site.