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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neuralset-0.3.1.tar.gz | 230.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neuralset-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 498.3 kB
Release files / neuralset-0.3.1.tar.gz
| Download URL | neuralset-0.3.1.tar.gz |
|---|---|
| Size | 230.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
722ad370ed19d774f48097be147f79a5425c247c922a2b8d1f75fbf875ca3e38
|
|
BLAKE2b-256 checksum How to use checksums |
de10d07f0863951f537dd367de86a2ca545fc1264a9a9d0f2c440fd2da4fe5e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.20
|
Release files / neuralset-0.3.1-py3-none-any.whl
| Download URL | neuralset-0.3.1-py3-none-any.whl |
|---|---|
| Size | 267.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
91adc7188792d81d8f2968d79cf2d33b838642e672da8b3543b30b86e7372967
|
|
BLAKE2b-256 checksum How to use checksums |
ce20c59f30a2afcf5c9ebce703dbcccbcf8e71125dc5a70427641b3c70120d65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.20
|