Skip to main content

Voxelwise Encoding Model tutorials

Github Python License Build Build Tutorials Downloads

Welcome to the Voxelwise Encoding Model tutorials, brought to you by the Gallant Lab.

Paper

If you use these tutorials for your work, consider citing the corresponding paper:

Dupré la Tour, T., Visconti di Oleggio Castello, M., & Gallant, J. L. (2024). The Voxelwise Encoding Model framework: a tutorial introduction to fitting encoding models to fMRI data. https://doi.org/10.31234/osf.io/t975e

You can find a copy of the paper here.

Tutorials

This repository contains tutorials describing how to use the Voxelwise Encoding Model (VEM) framework. VEM is a framework to perform functional magnetic resonance imaging (fMRI) data analysis, fitting encoding models at the voxel level.

To explore these tutorials, one can:

  • Read the rendered examples in the tutorials website (recommended).

  • Run the merged notebook in Colab.

  • Run the Jupyter notebooks (tutorials/notebooks directory) locally.

The tutorials are best explored in order, starting with the “shortclips” tutorial. The “vim2” tutorial is optional and redundant with the “shortclips” one.

Dockerfiles

This repository contains Dockerfiles to run the tutorials locally. Please see the instructions in the docker directory.

Helper Python package

To run the tutorials, this repository contains a small Python package called voxelwise_tutorials, with useful functions to download the data sets, load the files, process the data, and visualize the results.

Installation

To install the voxelwise_tutorials package, run:

pip install voxelwise_tutorials

To also download the tutorial scripts and notebooks, clone the repository via:

git clone https://github.com/gallantlab/voxelwise_tutorials.git
cd voxelwise_tutorials
pip install .

Developers can also install the package in editable mode via:

pip install --editable .

Requirements

The tutorials are not compatible with Windows. If you are using Windows, we recommend running the tutorials on Google Colab or in the provided Docker containers.

git-annex is required to download the data sets. Please follow the instructions in the git-annex documentation to install it on your system.

The tutorials and the package voxelwise_tutorials require Python 3.9 or higher.

The package voxelwise_tutorials has the following Python dependencies: numpy, scipy, h5py, scikit-learn, matplotlib, networkx, nltk, pycortex, himalaya, pymoten, datalad.

Cite as

If you use one of our packages in your work (voxelwise_tutorials [1], himalaya [2], pycortex [3], or pymoten [4]), please cite the corresponding publications:

Metadata

Release files for voxelwise-tutorials 0.2.3

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

Source distribution (sdist)

Source distribution for voxelwise-tutorials 0.2.3
File Size Uploaded
voxelwise_tutorials-0.2.3.tar.gz 27.6 kB Details

Release files / voxelwise_tutorials-0.2.3.tar.gz

Download URL voxelwise_tutorials-0.2.3.tar.gz
Size 27.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3fb211cf14883764f817a59abad01e6b043789bd13a70f58017c5ded354ddfd8
BLAKE2b-256 checksum
How to use checksums
1896c0024e8f4e215516f454d0c1b19587bc2dcaf355f93084032ea8f66053a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release history Release notifications | RSS feed

This release

0.2.3 This release

1 release file

0.2.2

1 release file

0.2.0

1 release file

0.1.9

1 release file

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

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