bnpm


Namebnpm JSON
Version 0.5.6 PyPI version JSON
download
home_pagehttps://github.com/RichieHakim/basic_neural_processing_modules
SummaryA library of useful modules for data analysis.
upload_time2025-03-18 20:38:08
maintainerNone
docs_urlNone
authorRichard Hakim
requires_pythonNone
licenseLICENSE
keywords data analysis machine learning neuroscience
VCS
bugtrack_url
requirements h5py eva_decord ipywidgets kornia matplotlib natsort numba numpy opencv_contrib_python opt_einsum optuna optuna_integration pandas paramiko psutil PyYAML pytest hypothesis scikit_learn tqdm seaborn sparse scipy sqlalchemy pymysql xxhash wandb tensorly torch torchvision torchaudio toolz tables pulp spconv torch_sparse av pynwb sendgrid pycuda cuml cupy cudf scanimage_tiff_reader jupyter PyWavelets mat73 pathos pygame psycopg2-binary
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/bnpm.svg)](https://badge.fury.io/py/bnpm)
[![Downloads](https://pepy.tech/badge/bnpm)](https://pepy.tech/project/bnpm)
[![repo size](https://img.shields.io/github/repo-size/RichieHakim/basic_neural_processing_modules)](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/e8/1f/6ae237f1d5a2e1b00122e43f6371489ff3fa05f7db3c4b89e3c9b032b95f/bnpm-0.5.6.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/bnpm.svg)](https://badge.fury.io/py/bnpm)\n[![Downloads](https://pepy.tech/badge/bnpm)](https://pepy.tech/project/bnpm)\n[![repo size](https://img.shields.io/github/repo-size/RichieHakim/basic_neural_processing_modules)](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.6",
    "project_urls": {
        "Homepage": "https://github.com/RichieHakim/basic_neural_processing_modules"
    },
    "split_keywords": [
        "data analysis",
        " machine learning",
        " neuroscience"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "687e91b0d7cfc893a9cd62acb074a7bbc2c3945cfad30c61344299ffdfe4f513",
                "md5": "eef39ff4d18f572a667493cceae2d52a",
                "sha256": "337877595e9345cd3c9a9d74eb4cb5d8945105ee2e42dbe72c5e5aa00441711e"
            },
            "downloads": -1,
            "filename": "bnpm-0.5.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eef39ff4d18f572a667493cceae2d52a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 254136,
            "upload_time": "2025-03-18T20:38:06",
            "upload_time_iso_8601": "2025-03-18T20:38:06.721265Z",
            "url": "https://files.pythonhosted.org/packages/68/7e/91b0d7cfc893a9cd62acb074a7bbc2c3945cfad30c61344299ffdfe4f513/bnpm-0.5.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e81f6ae237f1d5a2e1b00122e43f6371489ff3fa05f7db3c4b89e3c9b032b95f",
                "md5": "f04ad7c38b76a3547b74d8fe2a918ab6",
                "sha256": "ba1839ddaebf44490a63949a7df8b7410c5eed8305037a57f91c7327571234b3"
            },
            "downloads": -1,
            "filename": "bnpm-0.5.6.tar.gz",
            "has_sig": false,
            "md5_digest": "f04ad7c38b76a3547b74d8fe2a918ab6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 242435,
            "upload_time": "2025-03-18T20:38:08",
            "upload_time_iso_8601": "2025-03-18T20:38:08.880728Z",
            "url": "https://files.pythonhosted.org/packages/e8/1f/6ae237f1d5a2e1b00122e43f6371489ff3fa05f7db3c4b89e3c9b032b95f/bnpm-0.5.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-18 20:38:08",
    "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": [
        {
            "name": "h5py",
            "specs": []
        },
        {
            "name": "eva_decord",
            "specs": []
        },
        {
            "name": "ipywidgets",
            "specs": []
        },
        {
            "name": "kornia",
            "specs": []
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "natsort",
            "specs": []
        },
        {
            "name": "numba",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "opencv_contrib_python",
            "specs": []
        },
        {
            "name": "opt_einsum",
            "specs": []
        },
        {
            "name": "optuna",
            "specs": []
        },
        {
            "name": "optuna_integration",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": []
        },
        {
            "name": "paramiko",
            "specs": []
        },
        {
            "name": "psutil",
            "specs": []
        },
        {
            "name": "PyYAML",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "hypothesis",
            "specs": []
        },
        {
            "name": "scikit_learn",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "seaborn",
            "specs": []
        },
        {
            "name": "sparse",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        },
        {
            "name": "sqlalchemy",
            "specs": []
        },
        {
            "name": "pymysql",
            "specs": []
        },
        {
            "name": "xxhash",
            "specs": []
        },
        {
            "name": "wandb",
            "specs": []
        },
        {
            "name": "tensorly",
            "specs": []
        },
        {
            "name": "torch",
            "specs": []
        },
        {
            "name": "torchvision",
            "specs": []
        },
        {
            "name": "torchaudio",
            "specs": []
        },
        {
            "name": "toolz",
            "specs": []
        },
        {
            "name": "tables",
            "specs": []
        },
        {
            "name": "pulp",
            "specs": []
        },
        {
            "name": "spconv",
            "specs": []
        },
        {
            "name": "torch_sparse",
            "specs": []
        },
        {
            "name": "av",
            "specs": []
        },
        {
            "name": "pynwb",
            "specs": []
        },
        {
            "name": "sendgrid",
            "specs": []
        },
        {
            "name": "pycuda",
            "specs": []
        },
        {
            "name": "cuml",
            "specs": []
        },
        {
            "name": "cupy",
            "specs": []
        },
        {
            "name": "cudf",
            "specs": []
        },
        {
            "name": "scanimage_tiff_reader",
            "specs": []
        },
        {
            "name": "jupyter",
            "specs": []
        },
        {
            "name": "PyWavelets",
            "specs": []
        },
        {
            "name": "mat73",
            "specs": []
        },
        {
            "name": "pathos",
            "specs": []
        },
        {
            "name": "pygame",
            "specs": []
        },
        {
            "name": "psycopg2-binary",
            "specs": []
        }
    ],
    "lcname": "bnpm"
}
        
Elapsed time: 1.71878s