Skip to main content

neuralset

A Python toolkit for building neuroimaging data pipelines — from raw data to AI-ready batched tensors.

  • Event-driven processing with typed, validated DataFrames
  • Multi-modal extractors for MEG, EEG, fMRI, EMG, iEEG, text, image, audio, video
  • Caching and remote compute via exca

Install

pip install neuralset

Quick example

# First install study dependencies:
# pip install neuralfetch
import neuralset as ns

# Load a study and download its data (MNE sample, ~1.6GB on first run).
study = ns.Study(name="Mne2013Sample", path=ns.CACHE_FOLDER)
study.download()
events = study.run()

# Configure extractors
meg = ns.extractors.MegExtractor(frequency=100.0, filter=(0.5, 30))

# Segment around triggers and build a dataset
segmenter = ns.Segmenter(
    extractors=dict(meg=meg),
    trigger_query='type == "Stimulus"',
    start=-0.1, duration=0.5,
)
dataset = segmenter.apply(events)
batch = dataset.load_all()

Citation

If you use NeuralSet in your research, please cite NeuralSet: A High-Performing Python Package for Neuro-AI:

@article{king2026neuralset,
  title   = {NeuralSet: A High-Performing Python Package for Neuro-AI},
  author  = {King, J-R. and Bel, C. and Evanson, L. and Gadonneix, J. and Houhamdi, S. and L{\'e}vy, J. and Raugel, J. and Santos Revilla, A. and Zhang, M. and Bonnaire, J. and Caucheteux, C. and D{\'e}fossez, A. and Desbordes, T. and Diego-Sim{\'o}n, P. and Khanna, S. and Millet, J. and Orhan, P. and Panchavati, S. and Ratouchniak, A. and Thual, A. and Brooks, T. and Begany, K. and Benchetrit, Y. and Careil, M. and Banville, H. and d'Ascoli, S. and Dahan, S. and Rapin, J.},
  year    = {2026},
  url     = {https://kingjr.github.io/files/neuralset.pdf},
  note    = {Preprint; URL will be updated when the paper lands on arXiv}
}

Third-Party Content

References to third-party content from other locations are subject to their own licenses and you may have other legal obligations or restrictions that govern your use of that content.

License

This project is licensed under the MIT License. See LICENSE for details.

Release files for neuralset 0.3.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 neuralset 0.3.0
File Size Uploaded
neuralset-0.3.0.tar.gz 231.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for neuralset 0.3.0
File Interpreter ABI Platform
neuralset-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 499.1 kB

Release files / neuralset-0.3.0.tar.gz

Download URL neuralset-0.3.0.tar.gz
Size 231.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d400e247fa3c65aafdac23e86b05c58b7ca9590fac53fa88149c10322801bc7b
BLAKE2b-256 checksum
How to use checksums
363bcd7021610754b71f017d818b9adfb7deb634cda499a997a8b2abab46ea49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / neuralset-0.3.0-py3-none-any.whl

Download URL neuralset-0.3.0-py3-none-any.whl
Size 267.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c014983ef122253f0a4732fd054045d59b905cf5b7186f0a05cdeccd55f5561
BLAKE2b-256 checksum
How to use checksums
ef219580968466f2a0fdabee88594de90bd74694595d1918a9dc2bc85813bd24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

0.3.1

2 release files

This release

0.3.0 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

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