Skip to main content

Documentation | Paper

PyPI version Documentation Status Tests Linting

torch_brain is a Python library for various deep learning models designed for neuroscience.

Features

  • Multi-recording training
  • Optimized data loading with with on-demand data access -- only loads data when needed
  • Advanced samplers that enable arbitrary slicing of data on the fly
  • Advanced data collation strategies including chaining and padding
  • Support for arbitrary neural and behavioral modalities
  • Collection of useful nn.Modules like stitchers, multi-output readouts, infinite vocab embeddings, etc.
  • Collection of neural and behavioral transforms and augmentation strategies
  • Implementations of various deep learning models for neuroscience

List of implemented models

Installation

torch_brain is available for Python 3.9 to Python 3.11

To install the package, run the following command:

pip install pytorch_brain

Contributing

If you are planning to contribute to the package, you can install the package in development mode by running the following command:

pip install -e ".[dev]"

Install pre-commit hooks:

pre-commit install

Unit tests are located under test/. Run the entire test suite with

pytest

or test individual files via, e.g., pytest test/test_binning.py

Cite

Please cite our paper if you use this code in your own work:

@inproceedings{
    azabou2023unified,
    title={A Unified, Scalable Framework for Neural Population Decoding},
    author={Mehdi Azabou and Vinam Arora and Venkataramana Ganesh and Ximeng Mao and Santosh Nachimuthu and Michael Mendelson and Blake Richards and Matthew Perich and Guillaume Lajoie and Eva L. Dyer},
    booktitle={Thirty-seventh Conference on Neural Information Processing Systems},
    year={2023},
}

Metadata

Release files for pytorch-brain 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytorch-brain 0.1.0
File Size Uploaded
pytorch_brain-0.1.0.tar.gz 70.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytorch-brain 0.1.0
File Interpreter ABI Platform
pytorch_brain-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 135.9 kB

Release files / pytorch_brain-0.1.0.tar.gz

Download URL pytorch_brain-0.1.0.tar.gz
Size 70.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a2a3a3ef1ead1ba926984e93ea0a31abb098a8e47d5780ac465a00f268f6e2b4
BLAKE2b-256 checksum
How to use checksums
668b3a2401163fab01c98df18472da1f8ade1ccc70cfe6837c075225b0eaf89c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.6

Release files / pytorch_brain-0.1.0-py3-none-any.whl

Download URL pytorch_brain-0.1.0-py3-none-any.whl
Size 65.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a32f87abf633dcfbe853ae59f35525e860c63ea36cf1a93688c7a49028ec418b
BLAKE2b-256 checksum
How to use checksums
8091e25fba0f552cf2b97bf96d781a988faf9195e169706f1b843679028936da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page