# Spectrally regularised LVMs
*Spectrally-regularised-LVMs* is a Python-based [package](https://pypi.org/project/spectrally-regularised-lvms/) which facilitates the estimation of the linear latent variable model (LVM) parameters with a unique spectral regularisation term in single channel time-series applications.
## Purpose
LVMs are a statistical methodology which try to capture the underlying structure in some observed data. This package caters to single channel time-series applications and provides a methodology to estimate the LVM parameters. The model parameters are encouraged to capture non-duplicate information via a spectral regularisation term which penalises source duplication of the spectral information captured by the latent sources.
The purpose of this package is to provide a complete framework for LVMs with spectral regularisation that caters to a variety of LVM objective functions.
# Documentation
Please visit the [documentation](http://spectrally-regularised-lvms.readthedocs.io/) page for all supporting documentation for this package.
# Installation
The package is designed to be used through the Python API, and can be installed using [pip](https://pypi.org/project/pip/):
```console
$ pip install spectrally-regularised-LVMs
```
A more detailed discussion regarding installation is given in the [documentation](http://spectrally-regularised-lvms.readthedocs.io/).
# Requirements
This package used Python ≥ 3.10 or later to run. For other python dependencies, please check the `pyproject.toml`
[file](https://github.com/RyanBalshaw/spectrally-regularised-LVMs/blob/main/pyproject.toml) included in this repository. The dependencies of this package are as follows:
| Package | Version |
|:-----------------------------------------------:|:----------:|
| [Python](https://www.python.org/) | ≥ 3.10 |
| [Numpy](https://numpy.org/) | ≥ 1.23.1 |
| [Matplotlib](https://matplotlib.org/) | ≥ 3.5.2 |
| [SciPy](https://scipy.org/) | ≥ 1.8.1 |
| [scikit-learn](https://scikit-learn.org/) | ≥ 1.1.2 |
| [tqdm](https://github.com/tqdm/tqdm) | ≥ 4.64.1 |
| [SymPy](https://www.sympy.org/en/index.html) | ≥ 1.1.1 |
| [Poetry](https://python-poetry.org/) | ≥ 1.4 |
# API usage
Please visit [the docs](http://spectrally-regularised-lvms.readthedocs.io/) for all supporting API documentation for this package.
# Contributing
This package uses [Poetry](https://python-poetry.org/) for dependency management and Python packaging and [git](https://git-scm.com/) for version control. To get started, first install git and Poetry. Then one may clone this repository via
```console
$ git clone git@github.com:RyanBalshaw/spectrally-regularised-LVMs.git
$ cd spectrally-regularised-LVMs
```
Then, install the necessary dependencies in a local environment via
```console
$ poetry install --with dev,docs
$ poetry shell
```
This will install all necessary package dependencies and activate the virtual environment. You can then set up the [pre-commit](https://pre-commit.com/) hooks via
```console
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit
```
# License
This project is licensed under MIT License - see the [LICENSE](https://github.com/RyanBalshaw/spectrally-regularised-LVMs/blob/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/RyanBalshaw/spectrally-regularised-LVMs",
"name": "spectrally-regularised-lvms",
"maintainer": "Ryan Balshaw",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "ryanbalshaw81@gmail.com",
"keywords": "Linear LVMs,Spectral regularisation,Python",
"author": "Ryan Balshaw",
"author_email": "ryanbalshaw81@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8a/4d/4ae37313c6c27372b48a9e54bbbee60d201882b0d3486c3fdf92bca4b366/spectrally_regularised_lvms-0.1.3.tar.gz",
"platform": null,
"description": "# Spectrally regularised LVMs\n\n\n\n\n\n\n\n*Spectrally-regularised-LVMs* is a Python-based [package](https://pypi.org/project/spectrally-regularised-lvms/) which facilitates the estimation of the linear latent variable model (LVM) parameters with a unique spectral regularisation term in single channel time-series applications.\n\n## Purpose\nLVMs are a statistical methodology which try to capture the underlying structure in some observed data. This package caters to single channel time-series applications and provides a methodology to estimate the LVM parameters. The model parameters are encouraged to capture non-duplicate information via a spectral regularisation term which penalises source duplication of the spectral information captured by the latent sources.\n\nThe purpose of this package is to provide a complete framework for LVMs with spectral regularisation that caters to a variety of LVM objective functions.\n\n# Documentation\nPlease visit the [documentation](http://spectrally-regularised-lvms.readthedocs.io/) page for all supporting documentation for this package.\n\n# Installation\nThe package is designed to be used through the Python API, and can be installed using [pip](https://pypi.org/project/pip/):\n```console\n$ pip install spectrally-regularised-LVMs\n```\n\nA more detailed discussion regarding installation is given in the [documentation](http://spectrally-regularised-lvms.readthedocs.io/).\n\n# Requirements\n\nThis package used Python \u2265 3.10 or later to run. For other python dependencies, please check the `pyproject.toml`\n[file](https://github.com/RyanBalshaw/spectrally-regularised-LVMs/blob/main/pyproject.toml) included in this repository. The dependencies of this package are as follows:\n\n| Package \t | Version \t |\n|:-----------------------------------------------:|:----------:|\n| [Python](https://www.python.org/) \t | \u2265 3.10 \t |\n| [Numpy](https://numpy.org/) \t | \u2265 1.23.1 \t |\n| [Matplotlib](https://matplotlib.org/) \t | \u2265 3.5.2 \t |\n| [SciPy](https://scipy.org/) \t | \u2265 1.8.1 \t |\n| [scikit-learn](https://scikit-learn.org/) \t | \u2265 1.1.2 \t |\n| [tqdm](https://github.com/tqdm/tqdm) \t | \u2265 4.64.1 \t |\n| [SymPy](https://www.sympy.org/en/index.html) \t | \u2265 1.1.1 \t |\n| [Poetry](https://python-poetry.org/) \t | \u2265 1.4 \t |\n\n# API usage\nPlease visit [the docs](http://spectrally-regularised-lvms.readthedocs.io/) for all supporting API documentation for this package.\n\n# Contributing\nThis package uses [Poetry](https://python-poetry.org/) for dependency management and Python packaging and [git](https://git-scm.com/) for version control. To get started, first install git and Poetry. Then one may clone this repository via\n```console\n$ git clone git@github.com:RyanBalshaw/spectrally-regularised-LVMs.git\n$ cd spectrally-regularised-LVMs\n```\n\nThen, install the necessary dependencies in a local environment via\n```console\n$ poetry install --with dev,docs\n$ poetry shell\n```\n\nThis will install all necessary package dependencies and activate the virtual environment. You can then set up the [pre-commit](https://pre-commit.com/) hooks via\n```console\n$ pre-commit install\npre-commit installed at .git/hooks/pre-commit\n```\n\n# License\nThis project is licensed under MIT License - see the [LICENSE](https://github.com/RyanBalshaw/spectrally-regularised-LVMs/blob/main/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A framework of linear LVMs with spectral regularisation.",
"version": "0.1.3",
"project_urls": {
"Bug tracker": "https://github.com/RyanBalshaw/spectrally-regularised-LVMs/issues",
"Documentation": "https://spectrally-regularised-lvms.readthedocs.io/en/latest/",
"Homepage": "https://github.com/RyanBalshaw/spectrally-regularised-LVMs",
"Repository": "https://github.com/RyanBalshaw/spectrally-regularised-LVMs"
},
"split_keywords": [
"linear lvms",
"spectral regularisation",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e487db3e2ea9a0bb2ba5a8a2d77fe128955867781e6b6bc9a4c4c929bf758ea4",
"md5": "6662ad80e2192183c740a2d5402c01c3",
"sha256": "c324e6c3774f8d503b78943603c1230412d141c9aec7ab1c4bcbb8758db047d9"
},
"downloads": -1,
"filename": "spectrally_regularised_lvms-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6662ad80e2192183c740a2d5402c01c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 34264,
"upload_time": "2023-07-13T08:38:54",
"upload_time_iso_8601": "2023-07-13T08:38:54.117682Z",
"url": "https://files.pythonhosted.org/packages/e4/87/db3e2ea9a0bb2ba5a8a2d77fe128955867781e6b6bc9a4c4c929bf758ea4/spectrally_regularised_lvms-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a4d4ae37313c6c27372b48a9e54bbbee60d201882b0d3486c3fdf92bca4b366",
"md5": "8e8fd2e6b3acd702b963743032d4ed0d",
"sha256": "5a05b115c5faa04c89c3a905eba5ecfcb211496fccdb571cef4074d6b1153536"
},
"downloads": -1,
"filename": "spectrally_regularised_lvms-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "8e8fd2e6b3acd702b963743032d4ed0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 31902,
"upload_time": "2023-07-13T08:38:55",
"upload_time_iso_8601": "2023-07-13T08:38:55.496004Z",
"url": "https://files.pythonhosted.org/packages/8a/4d/4ae37313c6c27372b48a9e54bbbee60d201882b0d3486c3fdf92bca4b366/spectrally_regularised_lvms-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-13 08:38:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RyanBalshaw",
"github_project": "spectrally-regularised-LVMs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "contourpy",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "cycler",
"specs": [
[
"==",
"0.11.0"
]
]
},
{
"name": "fonttools",
"specs": [
[
"==",
"4.40.0"
]
]
},
{
"name": "joblib",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "kiwisolver",
"specs": [
[
"==",
"1.4.4"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.7.2"
]
]
},
{
"name": "mpmath",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.25.1"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"23.1"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"10.0.0"
]
]
},
{
"name": "pyparsing",
"specs": [
[
"==",
"3.0.9"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.8.2"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "scipy",
"specs": [
[
"==",
"1.9.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "sympy",
"specs": [
[
"==",
"1.12"
]
]
},
{
"name": "threadpoolctl",
"specs": [
[
"==",
"3.1.0"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.65.0"
]
]
}
],
"lcname": "spectrally-regularised-lvms"
}
JSON
