| Name | sweepystats JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Python package to perform the statistical sweep operation on symmetric numpy matrices |
| upload_time | 2024-12-22 00:03:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Benjamin Chu <benchu99@hotmail.com> and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sweep
matrix inverse
determinant
regression
anova
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sweepystats
*Because sweepy was taken*
`sweepystats` is a python package for performing the statistical [sweep operation](https://hua-zhou.github.io/teaching/biostatm280-2017spring/slides/11-sweep/sweep.html) on `numpy` matrices. The class `SweepMatrix` is a thin wrapper over numpy `darray`s that can be swept forward or backwards.
## Installation
:warning: **This is my hobby project during Christmas 2024. Use at your own risk!** :warning:
```shell
pip install sweepystats
```
## Features
The following operations are supported **in-place** and **allocation-free**:
+ Matrix inversions
+ Computation of determinants
+ Checking of (strict) positive-definiteness
+ Linear regression (beta hat, variance of OLS estimator, residuals)
## Running tests
1. Git clone the repo
2. Install `pytest` via `pip3 install pytest` if you haven't already
3. Execute `pytest tests` in the top level directory of `sweepy`
## Related packages
+ [SweepOperator.jl](https://github.com/joshday/SweepOperator.jl) in Julia
+ [sweep.operator](https://search.r-project.org/CRAN/refmans/fastmatrix/html/sweep.operator.html) in R
## References
+ [Biostats M280 lecture notes at UCLA](https://hua-zhou.github.io/teaching/biostatm280-2017spring/slides/11-sweep/sweep.html)
+ Section 7.4-7.6 of [Numerical Analysis for Statisticians](https://link.springer.com/book/10.1007/978-1-4419-5945-4) by Kenneth Lange (2010). Probably the best place to read about sweep operator.
+ [Blog post by SAS](https://blogs.sas.com/content/iml/2018/04/18/sweep-operator-sas.html)
## TODO
+ CI
+ Docs
+ PyPI
+ Number of download badge
+ Stepwise regression
+ Conditional formulas for MVN
+ MANOVA
+ Support single precision and complex
+ Benchmarks, e.g. timing comparison with `np.inv()` and `np.linalg.lstsq()`
+ Recursive tiling, see https://github.com/joshday/SweepOperator.jl/issues/9
+ Blog post
Raw data
{
"_id": null,
"home_page": null,
"name": "sweepystats",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sweep, matrix inverse, determinant, regression, ANOVA",
"author": null,
"author_email": "Benjamin Chu <benchu99@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/09/0a9cae42282911d7726dcd775e823e7aaac18ee4115c3b1759978a9020d2/sweepystats-0.0.4.tar.gz",
"platform": null,
"description": "# sweepystats\n\n*Because sweepy was taken*\n\n`sweepystats` is a python package for performing the statistical [sweep operation](https://hua-zhou.github.io/teaching/biostatm280-2017spring/slides/11-sweep/sweep.html) on `numpy` matrices. The class `SweepMatrix` is a thin wrapper over numpy `darray`s that can be swept forward or backwards. \n\n## Installation\n\n:warning: **This is my hobby project during Christmas 2024. Use at your own risk!** :warning:\n\n```shell\npip install sweepystats\n```\n\n## Features\n\nThe following operations are supported **in-place** and **allocation-free**:\n\n+ Matrix inversions\n+ Computation of determinants\n+ Checking of (strict) positive-definiteness\n+ Linear regression (beta hat, variance of OLS estimator, residuals)\n\n## Running tests\n\n1. Git clone the repo\n2. Install `pytest` via `pip3 install pytest` if you haven't already\n3. Execute `pytest tests` in the top level directory of `sweepy`\n\n## Related packages\n\n+ [SweepOperator.jl](https://github.com/joshday/SweepOperator.jl) in Julia\n+ [sweep.operator](https://search.r-project.org/CRAN/refmans/fastmatrix/html/sweep.operator.html) in R\n\n## References\n\n+ [Biostats M280 lecture notes at UCLA](https://hua-zhou.github.io/teaching/biostatm280-2017spring/slides/11-sweep/sweep.html)\n+ Section 7.4-7.6 of [Numerical Analysis for Statisticians](https://link.springer.com/book/10.1007/978-1-4419-5945-4) by Kenneth Lange (2010). Probably the best place to read about sweep operator.\n+ [Blog post by SAS](https://blogs.sas.com/content/iml/2018/04/18/sweep-operator-sas.html)\n\n## TODO\n+ CI\n+ Docs\n+ PyPI\n+ Number of download badge\n+ Stepwise regression\n+ Conditional formulas for MVN\n+ MANOVA\n+ Support single precision and complex\n+ Benchmarks, e.g. timing comparison with `np.inv()` and `np.linalg.lstsq()`\n+ Recursive tiling, see https://github.com/joshday/SweepOperator.jl/issues/9\n+ Blog post\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Benjamin Chu <benchu99@hotmail.com> and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python package to perform the statistical sweep operation on symmetric numpy matrices",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://biona001.github.io/sweepystats",
"Homepage": "https://github.com/biona001/sweepystats",
"Issues": "https://github.com/biona001/sweepystats/issues"
},
"split_keywords": [
"sweep",
" matrix inverse",
" determinant",
" regression",
" anova"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f20c811bd1ace41fc404f9211d010f95dec7c72d068259e0f972f1f722c88567",
"md5": "85dc7e4c5765510703b1b4c9da0112b7",
"sha256": "ef91ac3c9f04ce1f5e9b21cd5f2aa227e858d35077090ac14f07a9e5aea891f3"
},
"downloads": -1,
"filename": "sweepystats-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85dc7e4c5765510703b1b4c9da0112b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6767,
"upload_time": "2024-12-22T00:03:29",
"upload_time_iso_8601": "2024-12-22T00:03:29.585852Z",
"url": "https://files.pythonhosted.org/packages/f2/0c/811bd1ace41fc404f9211d010f95dec7c72d068259e0f972f1f722c88567/sweepystats-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3090a9cae42282911d7726dcd775e823e7aaac18ee4115c3b1759978a9020d2",
"md5": "6bd375e24d06b59b08e34529f73bba60",
"sha256": "842593fb276dd7c453f5ee58e22a343bdba5bc424b0a356c844e2a5c90269b85"
},
"downloads": -1,
"filename": "sweepystats-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "6bd375e24d06b59b08e34529f73bba60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6887,
"upload_time": "2024-12-22T00:03:33",
"upload_time_iso_8601": "2024-12-22T00:03:33.094312Z",
"url": "https://files.pythonhosted.org/packages/d3/09/0a9cae42282911d7726dcd775e823e7aaac18ee4115c3b1759978a9020d2/sweepystats-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 00:03:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biona001",
"github_project": "sweepystats",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sweepystats"
}
