Hyppo

**Note: People with a "+" by their names contributed a patch for the first time.**

**Release date:** 7 December 2021
**Supports:** Python 3.6+.

New features

* Functions now can be reproducible using a `random_state` parameter
* Add warning for redundant rows when running :class:`hyppo.independence.MGC`
* Tests now also retun a ``namedtuple``

Bug Fixes

* Change from L1 to L2 distance for the median heuristic
* Make median heuristic default for RBF and Gaussian kernels

Documentation

* Update license in ``setup.py``
* Change reference style and store reference in a ``refs.bib`` file
* Updated papers in documentation from preprint to published versions
* Rename badges in README

Maintenance

* Added support for Python 3.9
* Update ``pytest`` orbs version
* Make repository citeable with the new GitHub feature

Authors

+ sampan501
+ kareef928 +
+ rflperry
+ Verathagnus +
+ PSSF23 +
+ hadasarik +

**Note: People with a "+" by their names contributed a patch for the first time.**

**Release date:** 25 February 2021
**Supports:** Python 3.6+.

Bug Fixes

* `hyppo.independence.Dcorr` and `hyppo.independence.Hsic` when `auto=True` had low finite power, fixed.
* Fast exact statistic for `hyppo.independence.Dcorr` was incorrect, fixed

Documentation

* Fix PyPi description rendering issues
* Add more descriptive contributing guidelines
* Add ROLES.md for specification about maintainers
* Added power computation for independence increasing sample size and dimension
* Add benchmark section and move relevant examples there
* Add base classes

Maintenance

* Fix gaussian kernel to prevent division by 0
* Add checks for Type I error

Authors

+ Sambit Panda

**Note: People with a "+" by their names contributed a patch for the first time.**

**Release date:** 08 February 2021
**Supports:** Python 3.6+.

New features

* Added restricted permutation functionality for Dcorr
* Kernel functions now wrap scikit-learn and support keyword arguments
* `hyppo.ksample.Energy`
* `hyppo.ksample.DISCO`
* `hyppo.ksample.MMD`
* Fast 1D exact Dcorr `O(n log n)`
* `hyppo.ksample.Hotelling`
* `hyppo.ksample.MANOVA`
* `hyppo.independence.MaxMargin`

Bug Fixes

* Fixed error check for k-sample tests to be between samples instead of within
* Time series doesn't clip negative values
* Fix docs not building on netlify
* Fix p-value calculations for permutation tests to be more in line with the literature
* Fix `hyppo.independence.Dcorr` and `hyppo.independence.Hsic` incorrect stats

Documentation

* Update badges and README to FIRM guidelines
* Incorrect equation in :meth:`hyppo.tools.circle` docstring
* Update README to be in line with scikit-learn
* Remove literature reference section in docstrings, add links to papers
* Add docstrings for :mod:`hyppo.tools` functions
* Add ``overview.py`` file for an overview of the package
* Add tutorials folder, rewrite so it is more user-friendly (port independence, k-sample, time series)
* Add examples folder with more information about unique features
* Move to ``sphinx-gallery`` instead of nbconvert
* Use ``automodule`` instead of ``autoclass``
* Make clear about the package requirements and docs requirements
* Make ``changelog`` into a single file
* Add external links to neurodata and code of conduct
* Add citing page to cite the package papers
* Make index page a clone of README
* Update MakeFile for more options
* Add intersphinx mapping with links externally (``numpy``, ``scipy``, etc.) and internally
* Add docs for statistic function
* Add discriminability tutorial

Maintenance

* Fix typos in warning commits
* Updated tests to precalculate distance matrix
* Moved from Travis CI to Circle CI
* Raise base ``requirements.txt`` to fix failing tests on CircleCI
* Add code coverage config files
* Add documentation folders and files to ``.gitignore``
* Remove ``reps`` warning test
* Cache numba after first call to speed up runs
* Fix netlify config to new doc build structure

Authors

+ Sambit Panda
+ Vivek Gopalakrishnan +
+ Ronak Mehta
+ Ronan Perry +

hyppo 0.1.3 does not include any new features, just fixes. This release requires Python 3.6+.

Fixes

*k*-sample testing
Prevent division by zero when calculating using default gaussian median kernel.

Other
Used `chi2.sf` instead of `1 - chi2.cdf`

Authors

This release contains work by the following people (contributed at least one patch to this release, names in alphabetical order by last name):

* Benjamin Pedigo +
* Anton Alayakin +

People with a "+" by their names contributed a patch for the first time.

hyppo 0.1.2 does not include any new features, just fixes. This release requires Python 3.6+.

Fixes

*k*-sample testing
Fixed MMD/k-samp;e Hsic not running bug.

Authors

This release contains work by the following people (contributed at least one patch to this release, names in alphabetical order by last name):

* Sambit Panda

A total of 1 person contributed to this release. People with a "+" by their names contributed a patch for the first time.

hyppo 0.1.1 does not include any new features, just removal of extraneous features.

Release highlights:

- Kernel matrices calculated once before calculating p-values
- Pearson, Kendall, and Spearman are no longer tests

This release requires Python 3.6+.

Improvements

Independence testing
Null distribution added as a class atribute. Calculate kernel once before calculating p-value.

*k*-sample testing
Null distribution added as a class atribute. Calculate kernel once before calculating p-value. Upper and lower-case inputs are available for ``indep_test``.

Time series
Reference docs and tutorials added to Time Series module.

Other changes
OS/Software requirements and license changes updated in ReadME. ``pairwise_distances``
from ``sklearn`` used instead of ``cdist`` from ``scipy``.

Removed features
Pearson, Spearman, and Kendall are no longer tests within the package. arXiv
badge added to docs. Python 3.5 no longer supported.

Authors

This release contains work by the following people (contributed at least
one patch to this release, names in alphabetical order by last name):

* Ronak Mehta +
* Sambit Panda
* Bijan Varjavand +

A total of 3 people contributed to this release.
People with a "+" by their names contributed a patch for the first time.