[](https://badge.fury.io/py/bnpm)
[](https://pepy.tech/project/bnpm)
[](https://github.com/RichieHakim/basic_neural_processing_modules/)
# basic_neural_processing_modules
Personal library of functions used in analyzing neural data.
If you find a bug or just want to reach out: RichHakim@gmail.com
## Installation
Normal installation of `bnpm` does not install all possible dependencies; there are some specific functions that wrap libraries that may need to be installed separately on a case-by-case basis.
Install stable version:
```
pip install bnpm[core]
```
If installing on a server or any computer without graphics/display, install using `core_cv2Headless`. If you accidentally installed the normal version, simply please uninstall `pip uninstall opencv-contrib-python` and install `pip install opencv-contrib-python-headless` instead.
Install development version:
```
pip install git+https://github.com/RichieHakim/basic_neural_processing_modules.git
```
import with:
```
import bnpm
```
## Usage
My favorites:
- **`automatic_regression`** module
- Allows for easy and fast hyperparameter optimization of regression models
- Any model with a `fit` and `predict` method can be used (e.g. `sklearn` and similar)
- Uses `optuna` for hyperparameter optimization
Other useful functions:
- Signal Processing:
- `timeSeries.rolling_percentile_rq_multicore`
- Fast rolling percentile calculation
- `timeSeries.event_triggered_traces`
- Fast creation of a matrix of aligned traces relative to specified event times
- Machine Learning:
- `neural_networks` module
- Has nice RNN regression and classification classes
- `decomposition.torch_PCA`
- Fast standard PCA using PyTorch
- `similarity.orthogonalize`
- Orthogonalize a matrix relative to a set of vectors using OLS or Gram-Schmidt process
- Miscellaneous
- `path_helpers.find_paths`
- Find paths to files and/or folders in a directory. Searches recursively using regex.
- `image_processing.play_video_cv2`
- Plays and/or saves a 3D array as a video using OpenCV
- `h5_handling.simple_save` and `h5_handling.simple_load`
- Simple lazy loading and saving of dictionaries as nested h5 files
Raw data
{
"_id": null,
"home_page": "https://github.com/RichieHakim/basic_neural_processing_modules",
"name": "bnpm",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "data analysis, machine learning, neuroscience",
"author": "Richard Hakim",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fc/c7/cc4b0ddcf6d789735635fe2a50fb434cd8f0edd85bf10362091db9be2c1e/bnpm-0.5.5.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/bnpm)\n[](https://pepy.tech/project/bnpm)\n[](https://github.com/RichieHakim/basic_neural_processing_modules/)\n\n# basic_neural_processing_modules \nPersonal library of functions used in analyzing neural data.\nIf you find a bug or just want to reach out: RichHakim@gmail.com\n\n## Installation \nNormal installation of `bnpm` does not install all possible dependencies; there are some specific functions that wrap libraries that may need to be installed separately on a case-by-case basis.\n\nInstall stable version:\n```\npip install bnpm[core]\n```\n\nIf installing on a server or any computer without graphics/display, install using `core_cv2Headless`. If you accidentally installed the normal version, simply please uninstall `pip uninstall opencv-contrib-python` and install `pip install opencv-contrib-python-headless` instead. \n\n\nInstall development version:\n```\npip install git+https://github.com/RichieHakim/basic_neural_processing_modules.git\n```\n\nimport with:\n```\nimport bnpm\n```\n\n\n## Usage \nMy favorites:\n- **`automatic_regression`** module\n - Allows for easy and fast hyperparameter optimization of regression models\n - Any model with a `fit` and `predict` method can be used (e.g. `sklearn` and similar)\n - Uses `optuna` for hyperparameter optimization\n\nOther useful functions:\n- Signal Processing:\n - `timeSeries.rolling_percentile_rq_multicore`\n - Fast rolling percentile calculation\n - `timeSeries.event_triggered_traces`\n - Fast creation of a matrix of aligned traces relative to specified event times\n\n- Machine Learning:\n - `neural_networks` module\n - Has nice RNN regression and classification classes\n - `decomposition.torch_PCA`\n - Fast standard PCA using PyTorch\n - `similarity.orthogonalize`\n - Orthogonalize a matrix relative to a set of vectors using OLS or Gram-Schmidt process\n\n- Miscellaneous\n - `path_helpers.find_paths`\n - Find paths to files and/or folders in a directory. Searches recursively using regex.\n - `image_processing.play_video_cv2`\n - Plays and/or saves a 3D array as a video using OpenCV\n - `h5_handling.simple_save` and `h5_handling.simple_load`\n - Simple lazy loading and saving of dictionaries as nested h5 files\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "A library of useful modules for data analysis.",
"version": "0.5.5",
"project_urls": {
"Homepage": "https://github.com/RichieHakim/basic_neural_processing_modules"
},
"split_keywords": [
"data analysis",
" machine learning",
" neuroscience"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7a42690c0552980fa181835cfaf7f9e78c2f8da64fc58ebf6baf31e922ebf08",
"md5": "fbcaaf6b5a750ff68c27dc3c52a2bd47",
"sha256": "c2fb64057905139be8c513179289950b39fa04e7808e86b9bd19a5f2dfbde141"
},
"downloads": -1,
"filename": "bnpm-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbcaaf6b5a750ff68c27dc3c52a2bd47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 253844,
"upload_time": "2024-11-23T08:24:37",
"upload_time_iso_8601": "2024-11-23T08:24:37.704388Z",
"url": "https://files.pythonhosted.org/packages/b7/a4/2690c0552980fa181835cfaf7f9e78c2f8da64fc58ebf6baf31e922ebf08/bnpm-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fcc7cc4b0ddcf6d789735635fe2a50fb434cd8f0edd85bf10362091db9be2c1e",
"md5": "3413bd563ddcf4b2d28cf0f9a1d9b0ce",
"sha256": "471e06a2eac7aac0f6520705f17bd40a5ad25945137decdc36c529114ff610e1"
},
"downloads": -1,
"filename": "bnpm-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "3413bd563ddcf4b2d28cf0f9a1d9b0ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 242113,
"upload_time": "2024-11-23T08:24:40",
"upload_time_iso_8601": "2024-11-23T08:24:40.260506Z",
"url": "https://files.pythonhosted.org/packages/fc/c7/cc4b0ddcf6d789735635fe2a50fb434cd8f0edd85bf10362091db9be2c1e/bnpm-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 08:24:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RichieHakim",
"github_project": "basic_neural_processing_modules",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bnpm"
}
JSON
