# Python Changepoint Detection (changepoynt)
This is the repository hosting the **pip-installable** python package changepoynt. It implements several different change point detection techniques, while focusing mostly on "localized" algorithms, that could be run in an online fashion.
Current algorithms come from the field of:
* Statistics (Detection of Change in the statistical properties)
* Time Series Segmentation (Algorithms focused on comparing time series shap)
The package is aimed at execution performance (using JIT compilation and standing on the shoulders of giants like numpy and scipy) while also keeping code readable and maintainable. This includes comments as well as architectural choices. This might not be perfect, but we are trying!
All of our algorithms are implementations of a base changepoint detection interface and therefore are interchangeable. Currently, we are focused on shifting to the very common and existing sklearn interface of fit and predict. This enables our algorithms to be part of the standard sklearn pipeline for preprocessing.
# Installation
You can install `changepoynt` from the common package index [PyPi](https://pypi.org/project/changepoynt/) using the following line with pip:
pip install changepoynt
Please be aware, that we are currently in an alpha development phase, as this is part of a research project at the FAU Erlangen together with SIEMENS Energy developed by [me](https://www.cs6.tf.fau.eu/person/lucas-weber/). Nevertheless, we aim to be open-source and try our best to guarantee that all the code we use has very permissive licenses.
# Participating
We always love to get feedback or new ideas. If you have any of those, feel free to open an issue. We try to get back to you as soon as we can.
If you are an author of a paper in the field or have another algorithmic idea: Feel free to open a pull request. Currently, we are still working on the contribution guides. But if somebody already comes along and has an idea, we do not want to be in the way!
Raw data
{
"_id": null,
"home_page": "https://github.com/Lucew/changepoynt",
"name": "changepoynt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "changepoint timeseries engineering",
"author": "Lucas Weber",
"author_email": "weber-lucas@web.de",
"download_url": "https://files.pythonhosted.org/packages/71/fd/99a5433c54de8be92b8beae9181c407229b44cc053e774de7e2547a6cc3f/changepoynt-0.0.5.tar.gz",
"platform": null,
"description": "# Python Changepoint Detection (changepoynt)\r\n\r\n \r\n\r\nThis is the repository hosting the **pip-installable** python package changepoynt. It implements several different change point detection techniques, while focusing mostly on \"localized\" algorithms, that could be run in an online fashion.\r\n\r\n \r\n\r\nCurrent algorithms come from the field of:\r\n\r\n* Statistics (Detection of Change in the statistical properties)\r\n\r\n* Time Series Segmentation (Algorithms focused on comparing time series shap)\r\n\r\n \r\n\r\nThe package is aimed at execution performance (using JIT compilation and standing on the shoulders of giants like numpy and scipy) while also keeping code readable and maintainable. This includes comments as well as architectural choices. This might not be perfect, but we are trying!\r\n\r\n \r\n\r\nAll of our algorithms are implementations of a base changepoint detection interface and therefore are interchangeable. Currently, we are focused on shifting to the very common and existing sklearn interface of fit and predict. This enables our algorithms to be part of the standard sklearn pipeline for preprocessing.\r\n\r\n \r\n\r\n# Installation\r\n\r\nYou can install `changepoynt` from the common package index [PyPi](https://pypi.org/project/changepoynt/) using the following line with pip:\r\n\r\n \r\n\r\n pip install changepoynt\r\n\r\n \r\n\r\nPlease be aware, that we are currently in an alpha development phase, as this is part of a research project at the FAU Erlangen together with SIEMENS Energy developed by [me](https://www.cs6.tf.fau.eu/person/lucas-weber/). Nevertheless, we aim to be open-source and try our best to guarantee that all the code we use has very permissive licenses.\r\n\r\n# Participating\r\n\r\nWe always love to get feedback or new ideas. If you have any of those, feel free to open an issue. We try to get back to you as soon as we can.\r\n\r\n \r\n\r\nIf you are an author of a paper in the field or have another algorithmic idea: Feel free to open a pull request. Currently, we are still working on the contribution guides. But if somebody already comes along and has an idea, we do not want to be in the way!\r\n",
"bugtrack_url": null,
"license": "BSD License",
"summary": "Several change point detection methods implemented in python.",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/Lucew/changepoynt"
},
"split_keywords": [
"changepoint",
"timeseries",
"engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa2ab7614fdb1dbf7e1c424012932e7ccda674682bb955e19826fea2c289ccad",
"md5": "8373f60aac502f050e0ed513930ee020",
"sha256": "47c885671b5788b2d7cc89a168fae8a086149fbf2814f46bf971240f487efc0b"
},
"downloads": -1,
"filename": "changepoynt-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8373f60aac502f050e0ed513930ee020",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38655,
"upload_time": "2023-05-04T10:05:27",
"upload_time_iso_8601": "2023-05-04T10:05:27.193013Z",
"url": "https://files.pythonhosted.org/packages/fa/2a/b7614fdb1dbf7e1c424012932e7ccda674682bb955e19826fea2c289ccad/changepoynt-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71fd99a5433c54de8be92b8beae9181c407229b44cc053e774de7e2547a6cc3f",
"md5": "29afed8ad72bfe42d99e68885f645f9a",
"sha256": "8b114ad03ce496fbaa82d9f28edad7dae325f0026918eeab9feee54a291a3294"
},
"downloads": -1,
"filename": "changepoynt-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "29afed8ad72bfe42d99e68885f645f9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30484,
"upload_time": "2023-05-04T10:05:29",
"upload_time_iso_8601": "2023-05-04T10:05:29.617989Z",
"url": "https://files.pythonhosted.org/packages/71/fd/99a5433c54de8be92b8beae9181c407229b44cc053e774de7e2547a6cc3f/changepoynt-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 10:05:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Lucew",
"github_project": "changepoynt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "changepoynt"
}
JSON
