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.

Metadata

Release files for neuralset 0.4.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.4.0
File Size Uploaded
neuralset-0.4.0.tar.gz 239.1 kB Details

Built distribution (wheel)

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

Total release size: 516.3 kB

Release files / neuralset-0.4.0.tar.gz

Download URL neuralset-0.4.0.tar.gz
Size 239.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d00ea919b43bae4ca86a022247b3a6d96750aeb48551d06fbf104159fbea7d91
BLAKE2b-256 checksum
How to use checksums
24847cffef4a2e9d0a6c45bbc184415e9832b1638a022a3d5762b0edb6c9835a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

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

Download URL neuralset-0.4.0-py3-none-any.whl
Size 277.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36bc36856ac9a0bb423e38f3dc5e0023f416391a233cd55c3ee4f47962d9605a
BLAKE2b-256 checksum
How to use checksums
ff8ac4dcbd2d83f28f796c5e1180fda5371f82325f3641d9494bdb34dd3a4649
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.1

2 release files

0.3.0

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