Skip to main content
Python Version Coverage Status Github Actions Test Status Github Actions Linter Status Github Actions Doc Build Status Pypi Package

nidl

Nidl is a Python library to perform distributed training and evaluation of deep learning models on large-scale neuroimaging data (anatomical volumes and surfaces, fMRI).

It follows the PyTorch design for the training logic and the scikit-learn API for the models (in particular fit, predict and transform).

Supervised, self-supervised and unsupervised models are available (with pre-trained weights) along with open datasets.

Install

Latest release

1. Setup a virtual environment

We recommend that you install nidl in a virtual Python environment, either managed with the standard library venv or with conda. Either way, create and activate a new python environment.

With venv:

python3 -m venv /<path_to_new_env>
source /<path_to_new_env>/bin/activate

Windows users should change the last line to \<path_to_new_env>\Scripts\activate.bat in order to activate their virtual environment.

With conda:

conda create -n nidl python=3.12
conda activate nidl

2. Install nidl with pip

Execute the following command in the command prompt / terminal in the proper python environment:

python3 -m pip install -U nidl

Check installation

Try importing nidl in a python / iPython session:

import nidl

If no error is raised, you have installed nidl correctly.

Where to start

Examples are available in the gallery.

Dependencies

The required dependencies to use the software are listed in the file pyproject.toml.

Metadata

Release files for nidl 0.0.2

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

Source distribution (sdist)

Source distribution for nidl 0.0.2
File Size Uploaded
nidl-0.0.2.tar.gz 142.6 kB Details

Built distribution (wheel)

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

Total release size: 336.5 kB

Release files / nidl-0.0.2.tar.gz

Download URL nidl-0.0.2.tar.gz
Size 142.6 kB
Tags Source
SHA-256 checksum
How to use checksums
9c6a4beb4a5e671385344c52b4dde5832f840ef051db1aaeef34f4cd830fac60
BLAKE2b-256 checksum
How to use checksums
6f74c119e3c498dee224f5e03bbc17fdbf2135932d49a3642d2c5468010d8372
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.3

Release files / nidl-0.0.2-py3-none-any.whl

Download URL nidl-0.0.2-py3-none-any.whl
Size 193.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6265781456c211eb9759d746a93500fc3a6683e75a5459d91184d4aad0c09799
BLAKE2b-256 checksum
How to use checksums
f8d11af99e581eff35b9a48c7a3c3eff8d714ece7369c80ebdf01806454e7e28
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.0.2 This release

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