Merge pull request #291 from tky823/docs/release-0.2.0

CHANGELOG for 0.2.0

Author: tky823

CHANGELOG.rst

@@ -1,6 +1,43 @@
 Changelog
 #########
 
+v0.2.0
+******
+
+What's Changed
+==============
+
+Breaking Changes 🛠
+-------------------
+* Rename `aux` to `auxiliary` by @tky823 in https://github.com/tky823/ssspy/pull/268
+* Detailed build status by @tky823 in https://github.com/tky823/ssspy/pull/288
+
+New Features 🎉
+---------------
+* Implementation of harmonic vector analysis by @tky823 in https://github.com/tky823/ssspy/pull/271
+* Implementation of ADMM-HVA by @tky823 in https://github.com/tky823/ssspy/pull/281
+
+Bug Fixes 🐛
+------------
+* Fix test coverage by @tky823 in https://github.com/tky823/ssspy/pull/269
+* Fix timing of uploading package by @tky823 in https://github.com/tky823/ssspy/pull/273
+* Remove status badge of lint by @tky823 in https://github.com/tky823/ssspy/pull/274
+
+Other Changes
+-------------
+* Upload package to TestPyPI by @tky823 in https://github.com/tky823/ssspy/pull/267
+* Remove duplicate uploads to TestPyPI by @tky823 in https://github.com/tky823/ssspy/pull/270
+* Use flooring function to compute norm. by @tky823 in https://github.com/tky823/ssspy/pull/276
+* Regression tests by @tky823 in https://github.com/tky823/ssspy/pull/238
+* Add `needs` to upload_package job in GHA. by @tky823 in https://github.com/tky823/ssspy/pull/277
+* Update actions/checkout in GitHub actions by @tky823 in https://github.com/tky823/ssspy/pull/279
+* Hugging Face demo by @tky823 in https://github.com/tky823/ssspy/pull/282
+* Set permissions in workflows by @tky823 in https://github.com/tky823/ssspy/pull/289
+* Bump up version to 0.2.0 by @tky823 in https://github.com/tky823/ssspy/pull/290
+
+
+**Full Changelog**: https://github.com/tky823/ssspy/compare/v0.1.7...v0.2.0
+
 v0.1.7
 ******
 

docs/index.rst

@@ -12,14 +12,30 @@ Welcome to ssspy's documentation!
 .. image:: https://github.com/tky823/ssspy/actions/workflows/lint.yaml/badge.svg
    :target: https://github.com/tky823/ssspy/actions/workflows/lint.yaml
 
-.. image:: https://github.com/tky823/ssspy/actions/workflows/test_package.yaml/badge.svg
-   :target: https://github.com/tky823/ssspy/actions/workflows/test_package.yaml
-
 .. image:: https://codecov.io/gh/tky823/ssspy/branch/main/graph/badge.svg?token=IZ89MTV64G
    :target: https://codecov.io/gh/tky823/ssspy
 
 ``ssspy`` is a Python toolkit for sound source separation.
 
+Build status
+------------
+
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Python | Ubuntu                                                                                                                         | MacOS (x86_64)                                                                                                            | MacOS (arm64)                                                                                                                 | Windows                                                                                                                         |
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 3.9    | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.9.yaml/badge.svg?branch=main  | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.9.yaml/badge.svg?branch=main  | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.9.yaml/badge.svg?branch=main  | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.9.yaml/badge.svg?branch=main  |
+|        |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.9.yaml                       |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.9.yaml                       |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.9.yaml                       |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.9.yaml                       |
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+---------------------------------+
+| 3.10   | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.10.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.10.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.10.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.10.yaml/badge.svg?branch=main |
+|        |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.10.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.10.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.10.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.10.yaml                      |
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+---------------------------------+
+| 3.11   | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.11.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.11.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.11.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.11.yaml/badge.svg?branch=main |
+|        |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.11.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.11.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.11.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.11.yaml                      |
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+---------------------------------+
+| 3.12   | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.12.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.12.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.12.yaml/badge.svg?branch=main | .. image:: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.12.yaml/badge.svg?branch=main |
+|        |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_ubuntu-latest_python-3.12.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-13_python-3.12.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_macos-latest_python-3.12.yaml                      |    :target: https://github.com/tky823/ssspy/actions/workflows/test_package_windows-latest_python-3.12.yaml                      |
++--------+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+---------------------------------+
+
 Installation
 ------------