Skip to main content

A Python toolkit for sound source separation.

Project description

ssspy

Documentation Status tests codecov

A Python toolkit for sound source separation.

Installation

You can install by pip.

pip install ssspy

To install latest version,

pip install git+https://github.com/tky823/ssspy.git

Instead, you can build package from source.

git clone https://github.com/tky823/ssspy.git
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.

pip install -e ".[docs,notebooks]"

You need to convert some notebooks by the following command:

# in ssspy/
. ./docs/pre_build.sh

When you build the documentation, run the following command.

cd docs/
make html

Or, you can build the documentation automatically using sphinx-autobuild.

# in ssspy/
sphinx-autobuild docs docs/_build/html

Blind Source Separation Methods

Method Notebooks
Independent Component Analysis (ICA) [1-3] Gradient-descent-based ICA: Open in Colab
Natural-gradient-descent-based ICA: Open in Colab
Fast ICA: Open in Colab
Frequency-Domain Independent Component Analysis (FDICA) [4-6] Gradient-descent-based FDICA: Open in Colab
Natural-gradient-descent-based FDICA: Open in Colab
Auxiliary-function-based FDICA (IP1): Open in Colab
Auxiliary-function-based FDICA (IP2): Open in Colab
Gradient-descent-based Laplace-FDICA: Open in Colab
Natural-gradient-descent-based Laplace-FDICA: Open in Colab
Auxiliary-function-based Laplace-FDICA (IP1): Open in Colab
Auxiliary-function-based Laplace-FDICA (IP2): Open in Colab
Independent Vector Analysis (IVA) [7-14] Gradient-descent-based IVA: Open in Colab
Natural-gradient-descent-based IVA: Open in Colab
Fast IVA: Open in Colab
Faster IVA: Open in Colab
Auxiliary-function-based IVA (IP1): Open in Colab
Auxiliary-function-based IVA (IP2): Open in Colab
Auxiliary-function-based IVA (ISS1): Open in Colab
Auxiliary-function-based IVA (ISS2): Open in Colab
Auxiliary-function-based IVA (IPA): Open in Colab
Gradient-descent-based Laplace-IVA: Open in Colab
Natural-gradient-descent-based Laplace-IVA: Open in Colab
Auxiliary-function-based Laplace-IVA (IP1): Open in Colab
Auxiliary-function-based Laplace-IVA (IP2): Open in Colab
Auxiliary-function-based Laplace-IVA (ISS1): Open in Colab
Auxiliary-function-based Laplace-IVA (ISS2): Open in Colab
Auxiliary-function-based Laplace-IVA (IPA): Open in Colab
Gradient-descent-based Gauss-IVA: Open in Colab
Natural-gradient-descent-based Gauss-IVA: Open in Colab
Auxiliary-function-based Gauss-IVA (IP1): Open in Colab
Auxiliary-function-based Gauss-IVA (IP2): Open in Colab
Auxiliary-function-based Gauss-IVA (ISS1): Open in Colab
Auxiliary-function-based Gauss-IVA (ISS2): Open in Colab
Auxiliary-function-based Gauss-IVA (IPA): Open in Colab
Independent Low-Rank Matrix Analysis (ILRMA) [15-18] Gauss-ILRMA (IP1/MM): Open in Colab
Gauss-ILRMA (IP1/ME): Open in Colab
Gauss-ILRMA (IP2/MM): Open in Colab
Gauss-ILRMA (IP2/ME): Open in Colab
Gauss-ILRMA (ISS1/MM): Open in Colab
Gauss-ILRMA (ISS1/ME): Open in Colab
Gauss-ILRMA (ISS2/MM): Open in Colab
Gauss-ILRMA (ISS2/ME): Open in Colab
Gauss-ILRMA (IPA/MM): Open in Colab
Gauss-ILRMA (IPA/ME): Open in Colab
t-ILRMA (IP1/MM): Open in Colab
t-ILRMA (IP1/ME): Open in Colab
t-ILRMA (IP2/MM): Open in Colab
t-ILRMA (IP2/ME): Open in Colab
t-ILRMA (ISS1/MM): Open in Colab
t-ILRMA (ISS1/ME): Open in Colab
t-ILRMA (ISS2/MM): Open in Colab
t-ILRMA (ISS2/ME): Open in Colab
GGD-ILRMA (IP1/MM): Open in Colab
GGD-ILRMA (IP2/MM): Open in Colab
GGD-ILRMA (ISS1/MM): Open in Colab
GGD-ILRMA (ISS2/MM): Open in Colab
Independent Positive Semidefinite Tensor Analysis (IPSDTA) [19, 20] Gauss-IPSDTA (VCD): Open in Colab
t-IPSDTA (VCD): Open in Colab
Multichannel Nonnegative Matrix Factorization (MNMF) [21-24] Gauss-MNMF: Open in Colab
t-MNMF: soon
Fast Gauss-MNMF (IP1): Open in Colab
Fast Gauss-MNMF (IP2): Open in Colab
Blind Source Separation via Primal-Dual Splitting Algorithm (PDS-BSS) [25,26] PDS-BSS: Open in Colab
PDS-BSS-multiPenalty: Open in Colab
PDS-BSS-masking: Open in Colab
Blind Source Separation via Alternating Direction Method of Multipliers (ADMM-BSS) ADMM-BSS: Open in Colab
Harmonic Vector Analysis (HVA) [27] HVA: Open in Colab
Complex Angular Central Gaussian Mixture Model (cACGMM) [28] cACGMM: Open in Colab

LICENSE

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssspy-0.1.8.dev124.tar.gz (105.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssspy-0.1.8.dev124-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

Details for the file ssspy-0.1.8.dev124.tar.gz.

File metadata

  • Download URL: ssspy-0.1.8.dev124.tar.gz
  • Upload date:
  • Size: 105.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for ssspy-0.1.8.dev124.tar.gz
Algorithm Hash digest
SHA256 f33d8a829b928fba986225b03786db0233964ad13a7904ab2d1aa466f1aa8433
MD5 664cc812ae6301a775d75869e28d996d
BLAKE2b-256 d4f9688495609a05eeb617033601fe6c161af5021b918c28c100df0662e67960

See more details on using hashes here.

File details

Details for the file ssspy-0.1.8.dev124-py3-none-any.whl.

File metadata

  • Download URL: ssspy-0.1.8.dev124-py3-none-any.whl
  • Upload date:
  • Size: 122.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for ssspy-0.1.8.dev124-py3-none-any.whl
Algorithm Hash digest
SHA256 94a7844649a7b3f088c7afd290c61565bdd6c674f315a6bffbab31657a96e2b7
MD5 bd4c8f248622493e34a080ab11ec73f6
BLAKE2b-256 6d989ae118c7f7ece6d091f916e31df9c370a53f386b53e02643358ea04c7826

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page