Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release 0.4.0 #370

Merged
merged 2 commits into from
May 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Time-Series

MGCX
DcorrX

LjungBox


.. automodule:: hyppo.discrim
Expand Down
1 change: 1 addition & 0 deletions docs/changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This is the list of changes to hyppo between each release. For full details, see
.. toctree::
:maxdepth: 1

v0.4.0.md
v0.3.2.md
v0.3.1.md
v0.3.0.md
Expand Down
17 changes: 0 additions & 17 deletions docs/changelog/v0.3.3.md

This file was deleted.

107 changes: 105 additions & 2 deletions docs/changelog/v0.4.0.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# hyppo v0.3.0
# hyppo v0.4.0

> **Note:** hyppo v0.4.0 has not been released yet!

## Highlights of this release

hyppo v0.3.0 is the culmination of 12 months of hard work. It contains
hyppo v0.4.0 is the culmination of 12 months of hard work. It contains
many new features, numerous bug-fixes, improved test coverage and better
documentation. All users are encouraged to
upgrade to this release, as there are a large number of bug-fixes and
Expand All @@ -14,14 +14,117 @@ This release requires Python 3.6+.

## New features

* Add Ljung-Box test
* Add fast chi-square approximation to KMERF
* Add null distribution to DiscrimOneSample
* Add Fast HHG 2-sample test
* Add KCI test
* Add FCIT test

## Bug fixes

* Fixed energy statistic computation
* Fix type checking for permutation groups

## Documentation

* Incorrect inference in the overview doc file
* Fixed documentation rendering issues
* Fixed typos in various docstrings
* Make clear statistic issues in FR test

## Maintenance

* Make Circle CI faster
* Removed numpy >1.25 because of numba issues
* Migrate Netlify from Xenial to Focal
* Refactor kgof module
* Temporarily skip two-sample discrinability tets

## Authors

<a href="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/sampan501">
<img src="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/sampan501.png" width="50">
</a>
<a href="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/j1c">
<img src="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/j1c.png" width="50">
</a>
<a href="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/transpersonify">
<img src="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/transpersonify.png" width="50">
</a>
<a href="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/saivythik">
<img src="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/saivythik.png" width="50">
</a>
<a href="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/victoris93">
<img src="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/victoris93.png" width="50">
</a>
<a href="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/prabhatkgupta">
<img src="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/prabhatkgupta.png" width="50">
</a>
<a href="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/harsh204016">
<img src="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/harsh204016.png" width="50">
</a>
<a href="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/oakla">
<img src="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/oakla.png" width="50">
</a>
<a href="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/TacticalFallacy">
<img src="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/TacticalFallacy.png" width="50">
</a>
<a href="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/zdbzdb123123">
<img src="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/zdbzdb123123.png" width="50">
</a>
<a href="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/MatthewZhao26">
<img src="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/MatthewZhao26.png" width="50">
</a>
<a href="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/darsh-patel">
<img src="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/darsh-patel.png" width="50">
</a>

## Issues Closed

* [#333](https://github.com/neurodata/hyppo/issues/333): FIX migrate Netlify image from Xenial to Focal
* [#330](https://github.com/neurodata/hyppo/issues/330): The statistic returned by the `test` method is different to the statistic returned by the `statistic` method
* [#328](https://github.com/neurodata/hyppo/issues/328): Two typos
* [#325](https://github.com/neurodata/hyppo/issues/325): Locator files?
* [#344](https://github.com/neurodata/hyppo/issues/344): [BUG] Possible issue with numba and numpy 1.24 compatibilitiy
* [#350](https://github.com/neurodata/hyppo/issues/350): Lots missing from API reference
* [#348](https://github.com/neurodata/hyppo/issues/348): jupyter notebooks are no longer rendering in docs
* [#359](https://github.com/neurodata/hyppo/issues/359): About Module 'hyppo.conditional'
* [#363](https://github.com/neurodata/hyppo/issues/363): Incorrect Inference in Overview of Workflow using MGC?
* [#341](https://github.com/neurodata/hyppo/issues/341): Energy statistic is wrong

## PRs Merged

* [#310](https://github.com/neurodata/hyppo/pull/310): run pytest in parallel
* [#321](https://github.com/neurodata/hyppo/pull/321): add skip decorator for two sample circleci tests
* [#319](https://github.com/neurodata/hyppo/pull/319): update sphinx to fix jinja error
* [#318](https://github.com/neurodata/hyppo/pull/318): Refactor kgof module
* [#315](https://github.com/neurodata/hyppo/pull/315): FCIT
* [#317](https://github.com/neurodata/hyppo/pull/317): KCI Dev Pull Request
* [#314](https://github.com/neurodata/hyppo/pull/314): Fast HHG 2-Sample Test
* [#327](https://github.com/neurodata/hyppo/pull/327): fix typos
* [#331](https://github.com/neurodata/hyppo/pull/331): Stat ranges to docs
* [#335](https://github.com/neurodata/hyppo/pull/335): DOC remove extra comma in dcorr docstring
* [#336](https://github.com/neurodata/hyppo/pull/336): make docs clear about FR corrected stat
* [#337](https://github.com/neurodata/hyppo/pull/337): fix two typos in docs
* [#340](https://github.com/neurodata/hyppo/pull/340): Fix typo in distance covariance equation
* [#345](https://github.com/neurodata/hyppo/pull/345): bugfix: reduce maximum dependency of numpy to 1.23.5
* [#346](https://github.com/neurodata/hyppo/pull/346): Add null distribution to DiscrimOneSampleTestOutput
* [#352](https://github.com/neurodata/hyppo/pull/352): v0.4.0
* [#351](https://github.com/neurodata/hyppo/pull/351): Bump ipython from 7.31.1 to 8.10.0 in /docs
* [#356](https://github.com/neurodata/hyppo/pull/356): Bump ipython from 7.31.1 to 8.10.0 in /docs
* [#357](https://github.com/neurodata/hyppo/pull/357): Fix type checking
* [#361](https://github.com/neurodata/hyppo/pull/361): Parameter noise for function _square_dimond
* [#364](https://github.com/neurodata/hyppo/pull/364): Fixes typo/ wrong inference in overview.py
* [#366](https://github.com/neurodata/hyppo/pull/366): Addition of Ljung-Box test and a simulation
* [#368](https://github.com/neurodata/hyppo/pull/368): fix energy statistic bug
* [#369](https://github.com/neurodata/hyppo/pull/369): Add Fast kmerf
* [#371](https://github.com/neurodata/hyppo/pull/371): docs: add transpersonify as a contributor for doc
* [#372](https://github.com/neurodata/hyppo/pull/372): docs: add saivythik as a contributor for doc, and bug
* [#373](https://github.com/neurodata/hyppo/pull/373): docs: add victoris93 as a contributor for code
* [#374](https://github.com/neurodata/hyppo/pull/374): docs: add j1c as a contributor for code
* [#375](https://github.com/neurodata/hyppo/pull/375): docs: add prabhatkgupta as a contributor for bug
* [#376](https://github.com/neurodata/hyppo/pull/376): docs: add harsh204016 as a contributor for doc
* [#377](https://github.com/neurodata/hyppo/pull/377): docs: add oakla as a contributor for doc
* [#378](https://github.com/neurodata/hyppo/pull/378): docs: add MatthewZhao26 as a contributor for code

2 changes: 1 addition & 1 deletion hyppo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
import hyppo.d_variate
import hyppo.conditional

__version__ = "0.3.2"
__version__ = "0.4.0"
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ def run(self):
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
],
packages=find_packages(),
include_package_data=True,
Expand Down