Bump version to 0.5.0 and create release notes (#593)

* Bump version to 0.5.0 and create release notes * Update ccache
giotto-ai · Jul 8, 2021 · 51b2a8d · 51b2a8d
1 parent b429a66
commit 51b2a8d
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 7 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -46,7 +46,7 @@ jobs:
 
   - task: Cache@2
     inputs:
-      key: '"ccache-wheels-v2021.06.30" | $(Agent.OS) | "$(python.version)"'
+      key: '"ccache-wheels-v2021.07.08" | $(Agent.OS) | "$(python.version)"'
       path: $(CCACHE_DIR)
     displayName: ccache
 
@@ -146,7 +146,7 @@ jobs:
 
   - task: Cache@2
     inputs:
-      key: '"ccache-v2021.06.30" | $(Agent.OS) | "$(python.version)"'
+      key: '"ccache-v2021.07.08" | $(Agent.OS) | "$(python.version)"'
       path: $(CCACHE_DIR)
     displayName: ccache
 

diff --git a/doc/library.rst b/doc/library.rst
@@ -124,5 +124,5 @@ What's new
 
 .. include::
    release.rst
-   :start-after: Release 0.4.0
-   :end-before: Release 0.3.1
+   :start-after: Release 0.5.0
+   :end-before: Release 0.4.0
diff --git a/doc/release.rst b/doc/release.rst
@@ -4,6 +4,45 @@ Release Notes
 
 .. _stable:
 
+*************
+Release 0.5.0
+*************
+
+Major Features and Improvements
+===============================
+
+- An object-oriented API for interactive plotting of Mapper graphs has been added with the ``MapperInteractivePlotter`` (`#586 <https://github.com/giotto-ai/giotto-tda/pull/586>`_). This is intended to supersede ``plot_interactive_mapper`` graph as it allows for inspection of the current state of the objects change by interactivity. See also "Backwards-Incompatible Changes" below.
+- Further citations have been added to the mathematical glossary (`#564 <https://github.com/giotto-ai/giotto-tda/pull/564>`_).
+
+Bug Fixes
+=========
+
+- A bug preventing ``EuclideanCechPersistence`` from working correctly on point clouds in more than 2 dimensions has been fixed (`#588 <https://github.com/giotto-ai/giotto-tda/pull/588>`_).
+- A validation bug preventing ``VietorisRipsPersistence`` and ``WeightedRipsPersistence`` from accepting non-empty dictionaries as ``metric_params`` has been fixed (`#590 <https://github.com/giotto-ai/giotto-tda/pull/590>`_).
+- A bug causing an exception to be raised when ``node_color_statistic`` was passed as a numpy array in ``plot_static_mapper_graph`` has been fixed (`#576 <https://github.com/giotto-ai/giotto-tda/pull/576>`_).
+
+Backwards-Incompatible Changes
+==============================
+
+- A major change to the behaviour of the (static and interactive) Mapper plotting functions ``plot_static_mapper_graph`` and ``plot_interactive_mapper_graph`` was introduced in `#584 <https://github.com/giotto-ai/giotto-tda/pull/584>`_. The new ``MapperInteractivePlotter`` class (see "Major Features and Improvements" above) also follows this new API. The main changes are as follows:
+
+   - ``color_by_columns_dropdown``  has been eliminated.
+   - ``color_variable`` has been renamed to ``color_features`` (but cannot be an array).
+   - An additional keyword argument ``color_data`` has been added to more clearly separate the input ``data`` to the Mapper pipeline from the data to be used for coloring.
+   - ``node_color_statistic`` is now applied column by column -- previously it could end up being applied to 2d arrays as a whole.
+   - The defaults for color-related arguments lead to index values instead of the mean of the data.
+
+- The default for ``weight_params`` in ``WeightedRipsPersistence`` is now the empty dictionary, and ``None`` is no longer allowed (`#595 <https://github.com/giotto-ai/giotto-tda/pull/595>`_).
+
+Thanks to our Contributors
+==========================
+
+This release contains contributions from many people:
+
+Umberto Lupo, Wojciech Reise, Julian Burella Pérez, Sean Law, Anibal Medina-Mardones, and Lewis Tunstall
+
+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.4.0
 *************

diff --git a/doc/update_versions.py b/doc/update_versions.py
@@ -56,7 +56,8 @@ def process_file(file_name, versions):
     import os
     from glob import glob
     path = sys.argv[1]
-    file_names = [y for x in os.walk(path) for y in glob(os.path.join(x[0], '*.html'))]
+    file_names = [y for x in os.walk(path)
+                  for y in glob(os.path.join(x[0], '*.html'))]
     print(file_names)
 
     with open('versions', 'r') as f:

diff --git a/doc/versions b/doc/versions
@@ -4,4 +4,5 @@
 ./0.3.0
 ./0.3.1
 ./0.4.0
+./0.5.0
 ./latest
diff --git a/gtda/_version.py b/gtda/_version.py
@@ -19,4 +19,4 @@
 # 'X.Y.dev0' is the canonical version of 'X.Y.dev'
 #
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
diff --git a/setup.py b/setup.py
@@ -29,7 +29,7 @@
 MAINTAINER_EMAIL = "[email protected]"
 URL = "https://github.com/giotto-ai/giotto-tda"
 LICENSE = "GNU AGPLv3"
-DOWNLOAD_URL = "https://github.com/giotto-ai/giotto-tda/tarball/v0.4.0"
+DOWNLOAD_URL = "https://github.com/giotto-ai/giotto-tda/tarball/v0.5.0"
 VERSION = __version__  # noqa
 CLASSIFIERS = ["Intended Audience :: Science/Research",
                "Intended Audience :: Developers",
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ @@
     ./0.3.0
     ./0.3.1
     ./0.4.0
+    ./0.5.0
     ./latest