From 61bfb9ba9eb05c8edce9c6b3ce85fbc67c701408 Mon Sep 17 00:00:00 2001 From: Guillaume Tauzin Date: Fri, 12 Jun 2020 13:57:50 +0200 Subject: [PATCH] Preparation for v0.4.0 (#44) * Change version to 0.4.0 * Update releae notes * Add counts function to documentation index * Bump copyright year in doc * Fix doc authors Signed-off-by: Guillaume Tauzin Co-authored-by: Umberto Lupo <46537483+ulupo@users.noreply.github.com> --- RELEASE.rst | 38 ++++++++++++++++++++++++++++++++++---- doc/conf.py | 4 ++-- doc/index.rst | 3 +++ pyflagser/_version.py | 2 +- setup.py | 2 +- 5 files changed, 41 insertions(+), 8 deletions(-) diff --git a/RELEASE.rst b/RELEASE.rst index 54ba407..5513248 100644 --- a/RELEASE.rst +++ b/RELEASE.rst @@ -1,3 +1,33 @@ +Release 0.4.0 +============== + +Major Features and Improvements +------------------------------- +- ``flagser_count_unweighted`` and ``flagser_count_weighted`` were added to provide fast computations of simplex counts per dimension. +- ``flagser_unweighted`` and ``flagser_weighted``'s performance was improved when ``coeff`` is 2 by using a compiled version of C++ ``flagser`` without the ``USE_COEFFICIENTS`` flag. +- All C++ library files were moved to ``pyflagser/modules/`` upon compilation. +- The documentation of ``flagser_unweighted`` and ``flagser_weighted`` was further improved. +- Python bindings were made clearer, and documented for future maintenance. + +Bug Fixes +--------- +- A bug was fixed which caused ``flagser_unweighted`` and ``flagser_weighted``'s output persistence diagrams to be of shape ``(0,)`` instead of ``(0, 2)`` if empty. + +Backwards-Incompatible Changes +------------------------------ +None. + +Thanks to our Contributors +-------------------------- + +This release contains contributions from many people: + +Guillaume Tauzin, Umberto Lupo, and Julian Burella Pérez. + +We are also grateful to all who filed issues or helped resolve them, asked and +answered questions, and were part of inspiring discussions. + + Release 0.3.1 ============== @@ -68,13 +98,13 @@ Bug Fixes The following bug fixes were introduced: - A bug fix from C++ ``flagser`` on ``vertex_degree`` filtration has been propagated to pyflagser. - + - A bug in the C++ ``flagser`` bindings causing persistence diagrams and cell counts to be wrong based on the values of ``min_dimension`` and ``max_dimension`` has been fixed. - + - Tests were updated accordingly and `conftest.py` has been improved. - + - Bugs in the ``pyflagser`` ``flagser`` functions causing incompatibilities with sparse matrix and non-float datatype have been fixed. - + - ``CMakeLists`` has been updated to use C++14. This addresses problem when compiling on MacOS. Backwards-Incompatible Changes diff --git a/doc/conf.py b/doc/conf.py index 4c610bf..1a9be09 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -20,8 +20,8 @@ # -- Project information ----------------------------------------------------- project = 'pyflagser' -copyright = '2019, L2F' -author = 'Guillaume Tauzin, Julian Buerella Perez' +copyright = '2020, L2F' +author = 'Guillaume Tauzin, Julian Burella Pérez, Umberto Lupo' # The full version, including alpha/beta/rc tags release = __version__ diff --git a/doc/index.rst b/doc/index.rst index 89c7584..001cd62 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,3 +27,6 @@ Welcome to pyflagser's API reference! flagser_unweighted flagser_weighted + + flagser_count_unweighted + flagser_count_weighted diff --git a/pyflagser/_version.py b/pyflagser/_version.py index e0b2c89..1cfb3c2 100644 --- a/pyflagser/_version.py +++ b/pyflagser/_version.py @@ -17,4 +17,4 @@ # 'X.Y.dev0' is the canonical version of 'X.Y.dev' # -__version__ = '0.3.1' +__version__ = '0.4.0' diff --git a/setup.py b/setup.py index 6267e69..7df889c 100755 --- a/setup.py +++ b/setup.py @@ -28,7 +28,7 @@ MAINTAINER_EMAIL = 'maintainers@giotto.ai' URL = 'https://github.com/giotto-ai/pyflagser' LICENSE = 'GNU AGPLv3' -DOWNLOAD_URL = 'https://github.com/giotto-ai/pyflagser/tarball/v0.3.1' +DOWNLOAD_URL = 'https://github.com/giotto-ai/pyflagser/tarball/v0.4.0' VERSION = __version__ # noqa CLASSIFIERS = ['Intended Audience :: Science/Research', 'Intended Audience :: Developers',