compneurobilbao / ageml

AgeML is a Python package for Age Modelling with Machine Learning made easy.
Apache License 2.0
3 stars 1 forks source link
age-modelling machine-learning

ageml

ageml is a Python package for Age Modelling with Machine Learning made easy.

Zenodo doi badge PyPI version Lint Test Coverage

Background

Age Modelling consists of trying to predict the chronological age of an organism with a set of features that capture information about its aging status and dynamics. With a rich feature set one can accurately predict the chronological age of a normative (healthy) population using relatively simple machine learning models. When the feature set is sufficiently rich and the model can capture the complexity of the data, performing inference on non-normative populations leads to prediction errors in their chronological age. The mismatch between the chronological vs. predicted age (known as age delta) is a proxy of aberrant aging trajectories, often having high correlations with factors that condition ageing. Furthermore, classification of different clinical groups (e.g.: stable vs progressive) can also be done using the trained models.

Description

pipelines_figure ageml allows age modelling with a set of simple-to-use CLIs that produce comprehensive figures of the modelling steps and detailed logs for exploring the effectiveness of the trained models.

There are 4 main CLIs:

How to install ageml

Using pip (recommended)

From your terminal, for basic installation, run: pip install ageml

Cloning from Github

Note that ageml is under active development, but still not continuously deployed, so the latest version might not be available in PyPI. If you want to use the latest version, you can clone the repository and install it locally.

From your terminal, run: git clone https://github.com/compneurobilbao/ageml.git Then cd into the ageml folder, and install with pip:pip install .

Docker

There are two Dockerfiles available for ageml.

To build the pip image, run: docker build -t ageml:pip -f Dockerfile <path_to_directory_containing_Dockerfile> To build the latest image, run: docker build -t ageml:latest -f Dockerfile <path_to_directory_containing_Dockerfile>

To run the container, run: docker run -it ageml:<tag_of_your_image>

A developer Dockerfile will be available in the future for contributing to the project in a containerized fashion.

Developer installation

The developer installation is described in the contribution guidelines.

How to cite

If you use ageml in your work, please cite the all-time:

J. Garcia Condado, I. Tellaetxe Elorriaga, J. M. Cortes, and A. Erramuzpe, ‘AgeML: Age modelling with Machine Learning’. BioRxiv. May 05, 2024. doi: 10.1101/2024.05.02.592130.


@article{ageml_2024,
    title = {AgeML: Age modelling with Machine Learning},
    author = {Garcia Condado, Jorge and Tellaetxe Elorriaga, Iñigo  and Cortes, Jesus M. and Erramuzpe, Asier},
    url = {http://biorxiv.org/lookup/doi/10.1101/2024.05.02.592130},
    doi = {10.1101/2024.05.02.592130},
    month = may,
    year = {2024},
}

How to Contribute to the project

We welcome scientists and developers who want to standardize the procedures of age modelling, share pretrained models or whatever other kind of contribution that can help the project.

The contribution guidelines can be found here.

How to use ageml

A comprehensive, step by step tutorial of the tool can be found here.

Motivation

BrainAge models (Franke et al. 2010, Neuroimage) have had success in exploring the relationship between healthy and pathological ageing of the brain. Furthermore, this type of age modelling can be extended to multiple body systems and modelling of the interactions between them (Tian et al 2023, Nature Medicine).

However, there is no standard for age modelling. There have been works attempting to describe proper procedures, especially for age-bias correction (de Lange and Cole 2020, Neuroimage: Clinical). In this work we developed an Open-Source software that allows anyone to do age modelling following well-established and tested methodologies for any type of clinical data. Age modelling with machine learning made easy.

The objective of ageml is to standardise procedures, lower the barrier to entry into age modelling and ensure reproducibility. The project is Open-Source to create a welcoming environment and a community to work together to improve and validate existing methodologies. We are actively seeking new developers who want to contribute to growing and expanding the package.

References:

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.