Skip to main content

Deep learning classification with clinica

Project description

Clinica Logo + PyTorch Logo
ClinicaDL

Framework for the reproducible classification of Alzheimer's disease using deep learning

Build Status PyPI version Documentation Status

Documentation | Tutorial | Forum | See also: AD-ML, Clinica

About the project

This repository hosts the source code of a framework for the reproducible evaluation of deep learning classification experiments using anatomical MRI data for the computer-aided diagnosis of Alzheimer's disease (AD). This work has been published in Medical Image Analysis and is also available on arXiv.

Automatic classification of AD using classical machine learning approaches can be performed using the framework available here: https://github.com/aramis-lab/AD-ML.

Disclaimer: this software is under development. Some features can change between different commits. A stable version is planned to be released soon. The release v.0.0.1 corresponds to the date of submission of the publication but in the meantime important changes are being done to facilitate the use of the package.

The complete documentation of the project can be found on this page. If you find a problem when using it or if you want to provide us feedback, please open an issue or write on the forum.

Getting started

ClinicaDL currently supports macOS and Linux.

We recommend to use conda or virtualenv for the installation of ClinicaDL as it guarantees the correct management of libraries depending on common packages:

conda create --name ClinicaDL python=3.7
conda activate ClinicaDL
pip install clinicadl

:warning: NEW!: :warning:

:reminder_ribbon: Visit our hands-on tutorial web site to start using ClinicaDL directly in a Google Colab instance!

Overview

How to use ClinicaDL?

clinicadl is an utility that is used through the command line. Several tasks can be performed:

  • Preparation of your imaging data

    • T1w-weighted MR image preprocessing. The preprocessing task processes a dataset of T1 images stored in BIDS format and prepares to extract the tensors (see paper for details on the preprocessing). Output is stored using the CAPS hierarchy.
    • Quality check of preprocessed data. The quality_check task uses a pretrained network (Fonov et al, 2018) to classify adequately registered images.
    • Tensor extraction from preprocessed data. The extract task allows to create files in PyTorch format (.pt) with different options: the complete MRI, 2D slices and/or 3D patches. This files are also stored in the CAPS hierarchy.
  • Train & test your classifier

    • Train neural networks. The train task is designed to perform training of CNN models using different kind of inputs, e.g., a full MRI (3D-image), patches from a MRI (3D-patch), specific regions of a MRI (ROI-based) or slices extracted from the MRI (2D-slices). Parameters used during the training are configurable. This task allow also to train autoencoders.
    • MRI classification. The classify task uses previously trained models to perform the inference of a particular or a set of MRI.
  • Utilitaries used for the preparation of imaging data and/or training your classifier

    • Process TSV files. tsvtool includes many functions to get labels from BIDS, perform k-fold or single splits, produce demographic analysis of extracted labels and reproduce the restrictions made on AIBL and OASIS in the original paper.
    • Generate a synthetic dataset. The generate task is useful to obtain synthetic datasets frequently used in functional tests.

Pretrained models

Some of the pretained models for the CNN networks described in (Wen et al., 2020) are available on Zenodo: https://zenodo.org/record/3491003

Updated versions of the models will be published soon.

Related Repositories

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clinicadl-0.1.0rc1.tar.gz (73.1 kB view details)

Uploaded Source

Built Distribution

clinicadl-0.1.0rc1-py2.py3-none-any.whl (97.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file clinicadl-0.1.0rc1.tar.gz.

File metadata

  • Download URL: clinicadl-0.1.0rc1.tar.gz
  • Upload date:
  • Size: 73.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for clinicadl-0.1.0rc1.tar.gz
Algorithm Hash digest
SHA256 cff1c2abe36041381c6ee3b5f24124889385bc7b6aef7c307e0b1c638a18f9b8
MD5 d73bf257fbd83a870a9c562deec9e8c2
BLAKE2b-256 6d6b28d749458631f58d90888f8ead1fc06c00a0ce85c81497e785336d9e5452

See more details on using hashes here.

File details

Details for the file clinicadl-0.1.0rc1-py2.py3-none-any.whl.

File metadata

  • Download URL: clinicadl-0.1.0rc1-py2.py3-none-any.whl
  • Upload date:
  • Size: 97.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for clinicadl-0.1.0rc1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e0cb20f8ae015b2e78c989d7f30454f06d94714ccb2c97a8aa614b238a03a48b
MD5 e947ce466e3b6b9609d569007bfb1b49
BLAKE2b-256 6cfd576c6df727298e8deae6fdc4228d3aefd4fea5cda92000fddf5b9adff501

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page