Merge pull request #266 from tky823/release/v0.1.7

Bump up version to `v0.1.7`
tky823 · Oct 1, 2023 · 9e8cd6a · 9e8cd6a
2 parents 8d72583 + 3da913d
commit 9e8cd6a
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,19 +1,57 @@
 Changelog
-=========
+#########
+
+v0.1.7
+******
+
+Summary
+=======
+In this version, we improve the management of the package.
+As a new BSS method, ADMM-BSS is newly added.
+
+What's Changed
+==============
+
+Breaking Changes 🛠
+-------------------
+* Include ssspy only as package by @tky823 in https://github.com/tky823/ssspy/pull/253
+* Add ``MANIFEST.in`` by @tky823 in https://github.com/tky823/ssspy/pull/257
+
+New Features 🎉
+---------------
+* Implementation of ADMM-IVA by @tky823 in https://github.com/tky823/ssspy/pull/263
+* Support ADMM-BSS_multi-penalty by @tky823 in https://github.com/tky823/ssspy/pull/265
+
+Bug Fixes 🐛
+------------
+* Fix document deployment by @tky823 in https://github.com/tky823/ssspy/pull/255
+* Update some variables depending on ``demix_filter`` instead of ``self.algorithm``. by @tky823 in https://github.com/tky823/ssspy/pull/260
+
+Other Changes
+-------------
+* Release notes by @tky823 in https://github.com/tky823/ssspy/pull/246
+* Add label for breaking changes by @tky823 in https://github.com/tky823/ssspy/pull/247
+* Notebooks/getting started by @tky823 in https://github.com/tky823/ssspy/pull/248
+* Update docs and notebooks to install ``ssspy`` from pypi by @tky823 in https://github.com/tky823/ssspy/pull/251
+* Detect reformatting by @tky823 in https://github.com/tky823/ssspy/pull/258
+* Make PDSBSSBase inherit IterativeMethodBase by @tky823 in https://github.com/tky823/ssspy/pull/262
+
+
+**Full Changelog**: `v0.1.6...v0.1.7 <https://github.com/tky823/ssspy/compare/v0.1.6...v0.1.7>`_
 
 v0.1.6
-~~~~~~
+******
 
 Summary
--------
+=======
 In this version, the following BSS methods are newly added 🚀
 
 - Fast MNMF
 - IVA-IPA
 - ILRMA-IPA
 
 What's Changed
---------------
+==============
 * Bump up version to v0.1.5 by @tky823 in https://github.com/tky823/ssspy/pull/222
 * Rename "XXXbase" to "XXXBase" by @tky823 in https://github.com/tky823/ssspy/pull/224
 * Move default pair_selector by @tky823 in https://github.com/tky823/ssspy/pull/225

diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ cd ssspy
 pip install .
 ```
 
+If you cannot install `ssspy` due to failure in building wheel for numpy, please install numpy in advance.
+
 ## Build Documentation Locally (optional)
 To build the documentation locally, you have to include `docs` and `notebooks` when installing `ssspy`.
 ```shell

diff --git a/docs/index.rst b/docs/index.rst
@@ -50,6 +50,10 @@ Instead, you can build package from source.
    .. code-block:: shell
 
       python -m pip install --upgrade setuptools
+
+.. note::
+
+   If you cannot install `ssspy` due to failure in building wheel for numpy, please install numpy in advance.
 
 Build Documentation Locally (optional)
 --------------------------------------

diff --git a/docs/ssspy.bss.admmbss.rst b/docs/ssspy.bss.admmbss.rst
@@ -0,0 +1,10 @@
+ssspy.bss.admmbss
+=================
+
+Algorithms
+~~~~~~~~~~
+.. autoclass:: ssspy.bss.admmbss.ADMMBSSBase
+
+.. autoclass:: ssspy.bss.admmbss.ADMMBSS
+   :special-members: __call__
+   :members: update_once
diff --git a/docs/ssspy.bss.pdsbss.rst b/docs/ssspy.bss.pdsbss.rst
@@ -113,3 +113,11 @@ the updates by the proximal operator can be written as
 .. math::
    y_{ijn}
    \leftarrow\left(1 - \frac{\mu}{\sqrt{\sum_{i}|y_{ijn}|^{2}}}\right)_{+}y_{ijn}.
+
+Algorithms
+~~~~~~~~~~
+.. autoclass:: ssspy.bss.pdsbss.PDSBSSBase
+
+.. autoclass:: ssspy.bss.pdsbss.PDSBSS
+   :special-members: __call__
+   :members: update_once
diff --git a/docs/ssspy.bss.proxbss.rst b/docs/ssspy.bss.proxbss.rst
@@ -0,0 +1,8 @@
+ssspy.bss.proxbss
+=================
+
+Algorithms
+~~~~~~~~~~
+.. autoclass:: ssspy.bss.proxbss.ProxBSSBase
+    :special-members: __call__
+    :members: separate, compute_loss, compute_logdet, normalize_by_spectral_norm, restore_scale, apply_projection_back, apply_minimal_distortion_principle
diff --git a/docs/ssspy.bss.rst b/docs/ssspy.bss.rst
@@ -15,5 +15,7 @@ Submodules
    ssspy.bss.iva
    ssspy.bss.ilrma
    ssspy.bss.mnmf
+   ssspy.bss.proxbss
    ssspy.bss.pdsbss
+   ssspy.bss.admmbss
    ssspy.bss.cacgmm
diff --git a/ssspy/__init__.py b/ssspy/__init__.py
@@ -8,6 +8,6 @@
 try:
     from ._version import __version__
 except ModuleNotFoundError:
-    __version__ = "0.1.7-dev.1"
+    __version__ = "0.1.7"
 
 __all__ = ["__version__", "wavread", "wavwrite"]